Skip to main content

OpenAPI references

Plugin API spec

Please find the sidecar OpenAPI JSON spec can be found here.

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

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
{
  • "metadata": {
    },
  • "spec": {
    }
}

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

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
{
  • "namespace": "string",
  • "pod_uid": "string",
  • "pod_name": "string",
  • "container_name": "string",
  • "opts": {
    }
}

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Please find the interLink OpenAPI JSON spec can be found here.

interLink server API (0.4.0)

Download OpenAPI specification:Download

This is the API spec for the Virtual Kubelet to interLink API server communication

/create

Request Body schema: application/json
Array of objects or null (V1ConfigMap)
object (V1Pod)
Array of objects or null (V1ConfigMap)
Array of objects or null (V1Secret)

Responses

Request samples

Content type
application/json
{
  • "configmaps": [
    ],
  • "pod": {
    },
  • "projectedvolumesmaps": [
    ],
  • "secrets": [
    ]
}

Response samples

Content type
application/json
{
  • "container": [
    ],
  • "pod": {
    }
}

/delete

Request Body schema: application/json
apiVersion
string
kind
string
object (V1ObjectMeta)
object (V1PodSpec)
object (V1PodStatus)

Responses

Request samples

Content type
application/json
{
  • "apiVersion": "string",
  • "kind": "string",
  • "metadata": {
    },
  • "spec": {
    },
  • "status": {
    }
}

/getLogs

Request Body schema: application/json
ContainerName
string
Namespace
string
object (InterlinkContainerLogOpts)
PodName
string
PodUID
string

Responses

Request samples

Content type
application/json
{
  • "ContainerName": "string",
  • "Namespace": "string",
  • "Opts": {
    },
  • "PodName": "string",
  • "PodUID": "string"
}

Response samples

Content type
application/json
"string"

/pinglink

Responses

/status

Request Body schema: application/json
Array
apiVersion
string
kind
string
object (V1ObjectMeta)
object (V1PodSpec)
object (V1PodStatus)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]