interLink sidecar (v0.0.0)

Download OpenAPI specification:Download

openapi spec for interLink apis <-> provider sidecar communication

Create Pod

Request Body schema: application/json
required

Array

required	object (PodRequest)
required	Array of objects (Container)

Responses

Request samples

Payload

Content type

application/json

[{"pod": {"metadata": {"name": "string",
"namespace": "string",
"uid": "string",
"annotations": { },
"labels": { },
"generate_name": "string"
},
"spec": {"containers": [{"name": "string",
"image": "string",
"tag": "latest",
"command": ["string"
],
"args": [ ],
"resources": { },
"volume_mounts": [ ],
"env": [{"name": "string",
"value": "string",
"value_from": {"config_map_key_ref": {"key": null,
"name": null,
"optional": null
},
"secret_key_ref": {"key": null,
"name": null,
"optional": null
}
}
}
],
"security_context": {"allow_privilege_escalation": true,
"privileged": true,
"proc_mount": "string",
"read_only_file_system": true,
"run_as_group": 0,
"run_as_non_root": true,
"run_as_user": 0
}
}
],
"init_containers": [{"name": "string",
"image": "string",
"tag": "latest",
"command": ["string"
],
"args": [ ],
"resources": { },
"volume_mounts": [ ],
"env": [{"name": "string",
"value": "string",
"value_from": {"config_map_key_ref": {"key": null,
"name": null,
"optional": null
},
"secret_key_ref": {"key": null,
"name": null,
"optional": null
}
}
}
],
"security_context": {"allow_privilege_escalation": true,
"privileged": true,
"proc_mount": "string",
"read_only_file_system": true,
"run_as_group": 0,
"run_as_non_root": true,
"run_as_user": 0
}
}
],
"volumes": [{"name": "string",
"empty_dir": { },
"secret": {"secret_name": "string",
"items": [ ],
"optional": true,
"default_mode": 0
},
"config_map": {"name": "string",
"items": [ ],
"optional": true,
"default_mode": 0
}
}
],
"preemption_policy": "string",
"priority_class_name": "string",
"priority": 0,
"restart_policy": "string",
"termination_grace_period_seconds": 0
}
},
"container": [{"name": "string",
"config_maps": [{"metadata": {"name": "string",
"namespace": "string",
"uid": "string",
"annotations": { },
"labels": { },
"generate_name": "string"
},
"data": { },
"binary_data": { },
"type": "string",
"immutable": true
}
],
"secrets": [{"metadata": {"name": "string",
"namespace": "string",
"uid": "string",
"annotations": { },
"labels": { },
"generate_name": "string"
},
"data": { },
"string_data": { },
"type": "string",
"immutable": true
}
],
"empty_dirs": ["string"
]
}
]
}
]

Response samples

Content type

application/json

{"pod_uid": "string",
"pod_jid": "string"
}

Delete Pod

Request Body schema: application/json
required

required	object (Metadata)
required	object (PodSpec)

Responses

Request samples

Payload

Content type

application/json

{"metadata": {"name": "string",
"namespace": "string",
"uid": "string",
"annotations": { },
"labels": { },
"generate_name": "string"
},
"spec": {"containers": [{"name": "string",
"image": "string",
"tag": "latest",
"command": ["string"
],
"args": [ ],
"resources": { },
"volume_mounts": [ ],
"env": [{"name": "string",
"value": "string",
"value_from": {"config_map_key_ref": {"key": "string",
"name": "string",
"optional": true
},
"secret_key_ref": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"security_context": {"allow_privilege_escalation": true,
"privileged": true,
"proc_mount": "string",
"read_only_file_system": true,
"run_as_group": 0,
"run_as_non_root": true,
"run_as_user": 0
}
}
],
"init_containers": [{"name": "string",
"image": "string",
"tag": "latest",
"command": ["string"
],
"args": [ ],
"resources": { },
"volume_mounts": [ ],
"env": [{"name": "string",
"value": "string",
"value_from": {"config_map_key_ref": {"key": "string",
"name": "string",
"optional": true
},
"secret_key_ref": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"security_context": {"allow_privilege_escalation": true,
"privileged": true,
"proc_mount": "string",
"read_only_file_system": true,
"run_as_group": 0,
"run_as_non_root": true,
"run_as_user": 0
}
}
],
"volumes": [{"name": "string",
"empty_dir": { },
"secret": {"secret_name": "string",
"items": [ ],
"optional": true,
"default_mode": 0
},
"config_map": {"name": "string",
"items": [ ],
"optional": true,
"default_mode": 0
}
}
],
"preemption_policy": "string",
"priority_class_name": "string",
"priority": 0,
"restart_policy": "string",
"termination_grace_period_seconds": 0
}
}

Response samples

Content type

application/json

"string"

Status Pod

Request Body schema: application/json
required

Array

required	object (Metadata)
required	object (PodSpec)

Responses

Request samples

Payload

Content type

application/json

[{"metadata": {"name": "string",
"namespace": "string",
"uid": "string",
"annotations": { },
"labels": { },
"generate_name": "string"
},
"spec": {"containers": [{"name": "string",
"image": "string",
"tag": "latest",
"command": ["string"
],
"args": [ ],
"resources": { },
"volume_mounts": [ ],
"env": [{"name": "string",
"value": "string",
"value_from": {"config_map_key_ref": {"key": "string",
"name": "string",
"optional": true
},
"secret_key_ref": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"security_context": {"allow_privilege_escalation": true,
"privileged": true,
"proc_mount": "string",
"read_only_file_system": true,
"run_as_group": 0,
"run_as_non_root": true,
"run_as_user": 0
}
}
],
"init_containers": [{"name": "string",
"image": "string",
"tag": "latest",
"command": ["string"
],
"args": [ ],
"resources": { },
"volume_mounts": [ ],
"env": [{"name": "string",
"value": "string",
"value_from": {"config_map_key_ref": {"key": "string",
"name": "string",
"optional": true
},
"secret_key_ref": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"security_context": {"allow_privilege_escalation": true,
"privileged": true,
"proc_mount": "string",
"read_only_file_system": true,
"run_as_group": 0,
"run_as_non_root": true,
"run_as_user": 0
}
}
],
"volumes": [{"name": "string",
"empty_dir": { },
"secret": {"secret_name": "string",
"items": [ ],
"optional": true,
"default_mode": 0
},
"config_map": {"name": "string",
"items": [ ],
"optional": true,
"default_mode": 0
}
}
],
"preemption_policy": "string",
"priority_class_name": "string",
"priority": 0,
"restart_policy": "string",
"termination_grace_period_seconds": 0
}
}
]

Response samples

Content type

application/json

[{"name": "string",
"uid": "string",
"namespace": "string",
"containers": [{"name": "string",
"state": {"terminated": {"exit_code": 0,
"reason": "string"
},
"running": {"started_at": "string"
},
"waiting": {"message": "string",
"reason": "string"
}
}
}
]
}
]

Get Logs

Request Body schema: application/json
required

namespace required	string (Namespace)
pod_uid required	string (Pod Uid)
pod_name required	string (Pod Name)
container_name required	string (Container Name)
required	object (LogOpts)

Responses

Request samples

Payload

Content type

application/json

{"namespace": "string",
"pod_uid": "string",
"pod_name": "string",
"container_name": "string",
"opts": {"tail": 0,
"limit_bytes": 0,
"timestamps": true,
"previous": true,
"since_seconds": 0,
"since_time": "2019-08-24T14:15:22Z"
}
}

Response samples

Content type

application/json

{"detail": [{"loc": ["string"
],
"msg": "string",
"type": "string"
}
]
}

interLink sidecar (v0.0.0)

Create Pod

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete Pod

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Status Pod

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Logs

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required