Resources (API)

18KB

Container Manager Schema.yaml

Open

Get all service containers

get

Authorizations

AuthorizationstringRequired

Responses

200

All service containers

application/json

404

Failed to get all service containers

get

/containers

GET /api/containers HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "Names": [
      "text"
    ],
    "State": "text",
    "Mounts": [
      {
        "Type": "text",
        "Driver": "text",
        "Name": "text",
        "Source": "text",
        "Destination": "text",
        "Mode": "text",
        "RW": true,
        "Propagation": "text"
      }
    ]
  }
]

Inspect service container

get

Authorizations

AuthorizationstringRequired

Path parameters

namestringRequired

Name of the service container

Responses

200

Service container inspect

application/json

404

Failed to inspect service container

get

/containers/{name}/inspect

GET /api/containers/{name}/inspect HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "Name": "text",
  "Created": "text",
  "Id": "text",
  "State": {
    "Status": "text",
    "Dead": true,
    "FinishedAt": "text",
    "Paused": true,
    "Restarting": true,
    "Running": true,
    "StartedAt": "text"
  },
  "Mounts": [
    {
      "Name": "text",
      "Source": "text",
      "Destination": "text",
      "Mode": "text",
      "RW": true,
      "Propagation": "text"
    }
  ],
  "Config": {
    "Env": [
      "text"
    ],
    "Image": "text",
    "WorkingDir": "text",
    "ExposedPorts": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "Labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "HostConfig": {
    "CapAdd": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "Privileged": true
  }
}

Get service container logs

get

Authorizations

AuthorizationstringRequired

Path parameters

namestringRequired

Name of the service container

Query parameters

timestampsstring · enumOptional

If the logs should yield timestamp

Possible values:

tailstringOptional

Use 'all' to retrieve all, or a number for a limited set

sincestringOptional

Timestamp for the start

untilstringOptional

Timestamp for the end

Responses

200

Service container logs

application/json

stringOptional

404

Failed to get container logs

get

/containers/{name}/logs

GET /api/containers/{name}/logs HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

text

Get container state

get

Authorizations

AuthorizationstringRequired

Responses

200

Service container state

application/json

objectOptional

404

Failed to get service container state

get

/containers/{name}/state

GET /api/containers/{name}/state HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{}

Returns info about orchestrator being used to run Connectware

get

Authorizations

AuthorizationstringRequired

Responses

200

Returns the name of the orchestrator being used to run Connectware

application/json

orchestratorstring · enumRequiredPossible values:

403

Access Forbidden

503

Network error

get

/containers/orchestrator

GET /api/containers/orchestrator HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "orchestrator": "Docker"
}

Perform an operation on a service container

put

Authorizations

AuthorizationstringRequired

Path parameters

namestringRequired

Name of the service container

Body

operationstring · enumRequiredPossible values:

Responses

200

Service container inspection after operation is performed

application/json

objectOptional

400

Invalid request

404

Service container not found

put

/containers/{name}/operation

PUT /api/containers/{name}/operation HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "operation": "start"
}

{}

Get all core containers

get

Authorizations

AuthorizationstringRequired

Responses

200

All core containers

application/json

get

/core-containers

GET /api/core-containers HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

All core containers

[
  {
    "Names": [
      "text"
    ],
    "State": "text",
    "Mounts": [
      {
        "Type": "text",
        "Driver": "text",
        "Name": "text",
        "Source": "text",
        "Destination": "text",
        "Mode": "text",
        "RW": true,
        "Propagation": "text"
      }
    ]
  }
]

Inspect core container

get

Authorizations

AuthorizationstringRequired

Path parameters

namestringRequired

Name of the core container

Responses

200

Core container inspect

application/json

404

Failed to inspect core container

get

/core-containers/{name}/inspect

GET /api/core-containers/{name}/inspect HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "Name": "text",
  "Created": "text",
  "Id": "text",
  "State": {
    "Status": "text",
    "Dead": true,
    "FinishedAt": "text",
    "Paused": true,
    "Restarting": true,
    "Running": true,
    "StartedAt": "text"
  },
  "Mounts": [
    {
      "Name": "text",
      "Source": "text",
      "Destination": "text",
      "Mode": "text",
      "RW": true,
      "Propagation": "text"
    }
  ],
  "Config": {
    "Env": [
      "text"
    ],
    "Image": "text",
    "WorkingDir": "text",
    "ExposedPorts": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "Labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "HostConfig": {
    "CapAdd": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "Privileged": true
  }
}

Get core container logs

get

Authorizations

AuthorizationstringRequired

Path parameters

namestringRequired

Name of the core container

Query parameters

timestampsstring · enumOptional

If the logs should yield timestamp

Possible values:

tailstringOptional

Use 'all' to retrieve all, or a number for a limited set

sincestringOptional

Timestamp for the start

untilstringOptional

Timestamp for the end

Responses

200

Core container logs

application/json

stringOptional

404

Failed to get core container logs

get

/core-containers/{name}/logs

GET /api/core-containers/{name}/logs HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

text

Get core container state

get

Authorizations

AuthorizationstringRequired

Responses

200

Core Container state

application/json

objectOptional

404

Failed to get core container state

get

/core-containers/{name}/state

GET /api/core-containers/{name}/state HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{}

Returns info about orchestrator being used to run Connectware

get

Authorizations

AuthorizationstringRequired

Responses

200

Returns the name of the orchestrator being used to run Connectware

application/json

orchestratorstring · enumRequiredPossible values:

503

Network error

get

/core-containers/orchestrator

GET /api/core-containers/orchestrator HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "orchestrator": "Docker"
}

Perform an operation on a core container

put

Authorizations

AuthorizationstringRequired

Path parameters

namestringRequired

Name of the core container

Body

operationstring · enumRequiredPossible values:

Responses

200

Core container inspection after operation is performed

application/json

objectOptional

400

Invalid request

404

Core container not found

put

/core-containers/{name}/operation

PUT /api/core-containers/{name}/operation HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "operation": "start"
}

{}

Get all images

get

Authorizations

AuthorizationstringRequired

Responses

200

All images

application/json

object[]Optional

404

Failed to get all images

get

/images

GET /api/images HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {}
]

Inspect a image

get

Authorizations

AuthorizationstringRequired

Responses

200

Image inspect

application/json

objectOptional

404

Failed to inspect image

get

/images/{name}/inspect

GET /api/images/{name}/inspect HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{}

Get all networks

get

Authorizations

AuthorizationstringRequired

Responses

200

All networks

application/json

object[]Optional

404

Failed to get all networks

get

/networks

GET /api/networks HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {}
]

Inspect a network

get

Authorizations

AuthorizationstringRequired

Responses

200

Network inspect

application/json

objectOptional

404

Failed to inspect network

get

/networks/{name}/inspect

GET /api/networks/{name}/inspect HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{}

Get all volumes

get

Authorizations

AuthorizationstringRequired

Responses

200

All volumes

application/json

get

/volumes

GET /api/volumes HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

All volumes

{
  "Volumes": [
    {
      "CreatedAt": "text",
      "Name": "text",
      "Labels": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "Warnings": "text"
}

Inspect a volume

get

Authorizations

AuthorizationstringRequired

Path parameters

namestringRequired

Name of the volume

Responses

200

Volume inspect

application/json

404

Failed to inspect volume

get

/volumes/{name}/inspect

GET /api/volumes/{name}/inspect HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "CreatedAt": "text",
  "Name": "text",
  "Labels": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

PreviousServices (API)NextSystem Status (API)

Last updated 3 months ago

Was this helpful?

hashtagGet all service containers

hashtagInspect service container

hashtagGet service container logs

hashtagGet container state

hashtagReturns info about orchestrator being used to run Connectware

hashtagPerform an operation on a service container

hashtagGet all core containers

hashtagInspect core container

hashtagGet core container logs

hashtagGet core container state

hashtagReturns info about orchestrator being used to run Connectware

hashtagPerform an operation on a core container

hashtagGet all images

hashtagInspect a image

hashtagGet all networks

hashtagInspect a network

hashtagGet all volumes

hashtagInspect a volume

Get all service containers

Inspect service container

Get service container logs

Get container state

Returns info about orchestrator being used to run Connectware

Perform an operation on a service container

Get all core containers

Inspect core container

Get core container logs

Get core container state

Returns info about orchestrator being used to run Connectware

Perform an operation on a core container

Get all images

Inspect a image

Get all networks

Inspect a network

Get all volumes

Inspect a volume