outposts_service_connections_docker_create

POST 
/api/v3//outposts/service_connections/docker/

DockerServiceConnection Viewset

Request

application/json

Body

required

name stringrequired

Possible values: non-empty

local boolean

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

url stringrequired

Possible values: non-empty

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.

Responses

201

application/json

Schema

Schema

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.

Example (from schema)

{
  "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"
}

400

application/json

Schema

Schema

non_field_errors string[]
code string

Example (from schema)

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

403

application/json

Schema

Schema

detail stringrequired
code string

Example (from schema)

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

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X POST '/api/v3/outposts/service_connections/docker/' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "string",
  "local": true,
  "url": "string",
  "tls_verification": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "tls_authentication": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'

Request Collapse all

Base URL

/api/v3

Auth

Bearer Token

Body required

{
  "name": "string",
  "local": true,
  "url": "string",
  "tls_verification": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "tls_authentication": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}