outposts_service_connections_docker_list

GET /outposts/service_connections/docker/

DockerServiceConnection Viewset

Request

Query Parameters

local boolean

name string

ordering string

Which field to use when ordering the results.

page integer

A page number within the paginated result set.

page_size integer

Number of results to return per page.

search string

A search term.

tls_authentication uuid

tls_verification uuid

url string

Responses

application/json

Schema
Example (from schema)

Schema

pagination

object

required

next numberrequired

previous numberrequired

count numberrequired

current numberrequired

total_pages numberrequired

start_index numberrequired

end_index numberrequired

results

object[]

required

Array [

pk uuidrequired

name stringrequired

local boolean

If enabled, use the local connection. Required Docker socket/Kubernetes Integration

component stringrequired

verbose_name stringrequired

Return object's verbose_name

verbose_name_plural stringrequired

Return object's plural verbose_name

meta_model_name stringrequired

Return internal model name

url stringrequired

Can be in the format of 'unix://' when connecting to a local docker daemon, or 'https://:2376' when connecting to a remote system.

tls_verification uuidnullable

CA which the endpoint's Certificate is verified against. Can be left empty for no validation.

tls_authentication uuidnullable

Certificate/Key used for authentication. Can be left empty for no authentication.

]

{
  "pagination": {
    "next": 0,
    "previous": 0,
    "count": 0,
    "current": 0,
    "total_pages": 0,
    "start_index": 0,
    "end_index": 0
  },
  "results": [
    {
      "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "local": true,
      "component": "string",
      "verbose_name": "string",
      "verbose_name_plural": "string",
      "meta_model_name": "string",
      "url": "string",
      "tls_verification": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tls_authentication": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}

application/json

Schema
Example (from schema)

Schema

non_field_errors string[]

code string

property name* any

Validation Error

{
  "non_field_errors": [
    "string"
  ],
  "code": "string"
}

application/json

Schema
Example (from schema)

Schema

detail stringrequired

code string

{
  "detail": "string",
  "code": "string"
}

outposts_service_connections_docker_list