outposts_service_connections_docker_create

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

DockerServiceConnection Viewset

Request

application/json

Bodyrequired

namestringrequired

Possible values: non-empty

localboolean

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

urlstringrequired

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

Possible values: non-empty

tls_verificationuuidnullable

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

tls_authenticationuuidnullable

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

Responses

201

application/json

Schema

Schema

pkuuidrequired

namestringrequired

localboolean

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

componentstringrequired

verbose_namestringrequired

Return object's verbose_name

verbose_name_pluralstringrequired

Return object's plural verbose_name

meta_model_namestringrequired

Return internal model name

urlstringrequired

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

tls_verificationuuidnullable

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

tls_authenticationuuidnullable

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

Example (auto)

{
  "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_errorsstring[]

codestring

property name*any

Validation Error

Example (auto)

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

403

application/json

Schema

Schema

detailstringrequired
codestring

Example (auto)

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

Authorization: http

name: authentiktype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "/api/v3/outposts/service_connections/docker/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"name\": \"string\",\n  \"local\": true,\n  \"url\": \"string\",\n  \"tls_verification\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"tls_authentication\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

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