STstudio-saelix
Containers

Stop container

Changed on

Stops a running container. Requires admin role.

post/api/containers/{id}/stop

Request

  • Base URL
    https://localhost:1852
  • URL
    https://localhost:1852/api/containers/{id}/stop
  • Auth
    HTTP bearer

Path parameters

idinteger required

Numeric resource ID.

Headers

x-node-idinteger
Example:1

Target a specific node by ID. If omitted, the default node is used. Can also be passed as ?nodeId= query parameter.

Response

Container stopped.

messagestring required

Changes

  • d58cf9d6195bRevision changes
    • info

      removed the ADMIRAL_REQUIRED enum value from the response property for the response status

    • info

      removed the ADMIRAL_REQUIRED enum value from the response property for the response status

    • info

      removed the ADMIRAL_REQUIRED enum value from the response property for the response status

  • 7464894ea582Revision changes
    • warning

      added the new PAID_REQUIRED enum value to the response property for the response status

    • warning

      added the new PAID_REQUIRED enum value to the response property for the response status

    • warning

      added the new PAID_REQUIRED enum value to the response property for the response status

    • info

      removed the PRO_REQUIRED enum value from the response property for the response status

    • info

      removed the PRO_REQUIRED enum value from the response property for the response status

    • info

      removed the PRO_REQUIRED enum value from the response property for the response status