Skip to content
Nexa Platform Docs

Stop Warehouse

POST
/api/v1/warehouses/{warehouse_name}/stop
curl --request POST \
  --url https://example.com/api/v1/warehouses/example/stop

Stop (suspend) a warehouse.

Args: warehouse_name: Warehouse name

Returns: WarehouseOperationResponse with operation result

Raises: HTTPException: If operation fails

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
warehouse_name
required
Warehouse Name

Warehouse name

string

Warehouse name

Header Parameters

Section titled “Header Parameters”
X-Environment-Id
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WarehouseOperationResponse

Response model for warehouse operations (start/stop).

object
name
required
Name

Warehouse name

string
operation
required
Operation

Operation performed (start, stop, resume, suspend)

string
success
required
Success

Whether operation was successful

boolean
message
required
Message

Operation result message

string
new_state
Any of:
string
Examplegenerated
{
  "name": "example",
  "operation": "example",
  "success": true,
  "message": "example",
  "new_state": "example"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}