Search or ask Docker

Create a secret

POST /secrets/create — Docker Engine API 1.57.

View Markdown
POST/secrets/create

Connection and access

API connection and authentication guidance

/v1.57

No HTTP authentication requirement is declared for this operation. Transport access controls can still apply.

Parameters

No parameters are declared.

Request and responses

Request

application/json

All constraints apply

Schema: SecretSpec

Type: object

All schema constraints and annotations
{
  "example": {
    "Data": "VEhJUyBJUyBOT1QgQSBSRUFMIENFUlRJRklDQVRFCg==",
    "Driver": {
      "Name": "secret-bucket",
      "Options": {
        "OptionA": "value for driver option A",
        "OptionB": "value for driver option B"
      }
    },
    "Labels": {
      "foo": "bar"
    },
    "Name": "app-key.crt"
  },
  "type": "object"
}
All schema constraints and annotations
{
  "allOf": [
    {
      "$ref": "#/components/schemas/SecretSpec"
    },
    {
      "example": {
        "Data": "VEhJUyBJUyBOT1QgQSBSRUFMIENFUlRJRklDQVRFCg==",
        "Driver": {
          "Name": "secret-bucket",
          "Options": {
            "OptionA": "value for driver option A",
            "OptionB": "value for driver option B"
          }
        },
        "Labels": {
          "foo": "bar"
        },
        "Name": "app-key.crt"
      },
      "type": "object"
    }
  ]
}

Response 201

no error

application/json

Schema: IDResponse

Response 409

name conflicts with an existing object

application/json

Schema: ErrorResponse

Schema example

{
  "message": "Something went wrong."
}

Response 500

server error

application/json

Schema: ErrorResponse

Schema example

{
  "message": "Something went wrong."
}

Response 503

node is not part of a swarm

application/json

Schema: ErrorResponse

Schema example

{
  "message": "Something went wrong."
}

Referenced schemas

#/components/schemas/ErrorResponse

#/components/schemas/IDResponse

#/components/schemas/SecretSpec

Complete operation contract
{
  "operationId": "SecretCreate",
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "allOf": [
            {
              "$ref": "#/components/schemas/SecretSpec"
            },
            {
              "example": {
                "Data": "VEhJUyBJUyBOT1QgQSBSRUFMIENFUlRJRklDQVRFCg==",
                "Driver": {
                  "Name": "secret-bucket",
                  "Options": {
                    "OptionA": "value for driver option A",
                    "OptionB": "value for driver option B"
                  }
                },
                "Labels": {
                  "foo": "bar"
                },
                "Name": "app-key.crt"
              },
              "type": "object"
            }
          ]
        }
      }
    },
    "x-codegen-request-body-name": "body"
  },
  "responses": {
    "201": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/IDResponse"
          }
        }
      },
      "description": "no error"
    },
    "409": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorResponse"
          }
        }
      },
      "description": "name conflicts with an existing object"
    },
    "500": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorResponse"
          }
        }
      },
      "description": "server error"
    },
    "503": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorResponse"
          }
        }
      },
      "description": "node is not part of a swarm"
    }
  },
  "summary": "Create a secret",
  "tags": [
    "Secret"
  ]
}