Resources (API)

18KB

Container Manager Schema.yaml

Get all service containers

get

Authorizations

Responses

200

All service containers

application/json

Responseone of

404

Failed to get all service containers

get

GET /api/containers HTTP/1.1
Host: 
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

Path parameters

namestringRequired

Name of the service container

Responses

200

Service container inspect

application/json

Responseone of

404

Failed to inspect service container

get

GET /api/containers/{name}/inspect HTTP/1.1
Host: 
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

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

Responsestring

404

Failed to get container logs

get

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

text

Get container state

get

Authorizations

Responses

200

Service container state

application/json

Responseobject

404

Failed to get service container state

get

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

{}

Returns info about orchestrator being used to run Connectware

get

Authorizations

Responses

200

Returns the name of the orchestrator being used to run Connectware

application/json

403

Access Forbidden

503

Network error

get

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

{
  "orchestrator": "Docker"
}

Perform an operation on a service container

put

Authorizations

Path parameters

namestringRequired

Name of the service container

Body

operationstring · enumRequiredPossible values:

Responses

200

Service container inspection after operation is performed

application/json

Responseobject

400

Invalid request

404

Service container not found

put

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

{
  "operation": "start"
}

{}

Get all core containers

get

Authorizations

Responses

200

All core containers

application/json

Responseone of

get

GET /api/core-containers HTTP/1.1
Host: 
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

Path parameters

namestringRequired

Name of the core container

Responses

200

Core container inspect

application/json

Responseone of

404

Failed to inspect core container

get

GET /api/core-containers/{name}/inspect HTTP/1.1
Host: 
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

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

Responsestring

404

Failed to get core container logs

get

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

text

Get core container state

get

Authorizations

Responses

200

Core Container state

application/json

Responseobject

404

Failed to get core container state

get

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

{}

Returns info about orchestrator being used to run Connectware

get

Authorizations

Responses

200

Returns the name of the orchestrator being used to run Connectware

application/json

503

Network error

get

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

{
  "orchestrator": "Docker"
}

Perform an operation on a core container

put

Authorizations

Path parameters

namestringRequired

Name of the core container

Body

operationstring · enumRequiredPossible values:

Responses

200

Core container inspection after operation is performed

application/json

Responseobject

400

Invalid request

404

Core container not found

put

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

{
  "operation": "start"
}

{}

Get all images

get

Authorizations

Responses

200

All images

application/json

Responseobject[]

404

Failed to get all images

get

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

[
  {}
]

Inspect a image

get

Authorizations

Responses

200

Image inspect

application/json

Responseobject

404

Failed to inspect image

get

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

{}

Get all networks

get

Authorizations

Responses

200

All networks

application/json

Responseobject[]

404

Failed to get all networks

get

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

[
  {}
]

Inspect a network

get

Authorizations

Responses

200

Network inspect

application/json

Responseobject

404

Failed to inspect network

get

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

{}

Get all volumes

get

Authorizations

Responses

200

All volumes

application/json

Responseone of

get

GET /api/volumes HTTP/1.1
Host: 
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

Path parameters

namestringRequired

Name of the volume

Responses

200

Volume inspect

application/json

Responseone of

404

Failed to inspect volume

get

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

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

PreviousServices (API)NextSystem Status (API)

Last updated 23 days ago

Was this helpful?