Own Docker? Customize your docs with AI search, analytics, and more.

POST

Update a swarm

/v1.33/swarm/update

Access Token Required: API Key

Query Params

versionintegerrequired

The version number of the swarm object being updated. This is required to avoid conflicting writes.

rotateWorkerTokenbooleanDefault: false

Rotate the worker join token.

rotateManagerTokenbooleanDefault: false

Rotate the manager join token.

rotateManagerUnlockKeybooleanDefault: false

Rotate the manager unlock key.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url '/v1.33/swarm/update' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

Update a swarm

/v1.33/swarm/update

Access Token Required: API Key

Query Params

versionintegerrequired

The version number of the swarm object being updated. This is required to avoid conflicting writes.

rotateWorkerTokenbooleanDefault: false

Rotate the worker join token.

rotateManagerTokenbooleanDefault: false

Rotate the manager join token.

rotateManagerUnlockKeybooleanDefault: false

Rotate the manager unlock key.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url '/v1.33/swarm/update' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

Update a swarm

/v1.33/swarm/update

Access Token Required: API Key

Query Params

versionintegerrequired

The version number of the swarm object being updated. This is required to avoid conflicting writes.

rotateWorkerTokenbooleanDefault: false

Rotate the worker join token.

rotateManagerTokenbooleanDefault: false

Rotate the manager join token.

rotateManagerUnlockKeybooleanDefault: false

Rotate the manager unlock key.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url '/v1.33/swarm/update' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

Update a swarm

/v1.33/swarm/update

Access Token Required: API Key

Query Params

versionintegerrequired

The version number of the swarm object being updated. This is required to avoid conflicting writes.

rotateWorkerTokenbooleanDefault: false

Rotate the worker join token.

rotateManagerTokenbooleanDefault: false

Rotate the manager join token.

rotateManagerUnlockKeybooleanDefault: false

Rotate the manager unlock key.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url '/v1.33/swarm/update' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}