Docker

Remove Container

Changed on

Remove a bot container created by this API and archive its bot data.

NOTE: This endpoint only works with containers this API manages. A bot container is named after its instance verbatim, and owns the bots/instances/<container_name> directory that this endpoint archives; an unrelated container on the host has no such directory and is refused.

Args: container_name: Name of the bot container to remove archive_locally: Whether to archive data locally (default: True) s3_bucket: S3 bucket name for cloud archiving (optional) docker_service: Docker service dependency bot_archiver: Bot archiver service dependency

Returns: Response from container removal operation

Raises: HTTPException: 400 if the container is not a bot managed by this API HTTPException: 500 if archiving fails

post/docker/remove-container/{container_name}

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/docker/remove-container/{container_name}
  • Auth
    HTTP basic

Path parameters

container_namestring required

Query parameters

archive_locallyboolean
s3_bucketstring

Response

Successful Response

unknown required

Changes

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • breaking

      the response's body type changed from object to no type for status