Endpoints
Pause endpoint
Endpoints
Pause endpoint
Toggles an endpoint’s status between active and paused states
PUT
/
v1
/
projects
/
{projectID}
/
endpoints
/
{endpointID}
/
pause
curl --request PUT \
--url https://dashboard.getconvoy.io/api/v1/projects/{projectID}/endpoints/{endpointID}/pause \
--header 'Authorization: <api-key>'
{
"message": "<string>",
"status": true,
"data": {
"advanced_signatures": true,
"authentication": {
"api_key": {
"header_name": "<string>",
"header_value": "<string>"
},
"type": "api_key"
},
"created_at": "<string>",
"deleted_at": "<string>",
"description": "<string>",
"events": 123,
"failure_rate": 123,
"http_timeout": 123,
"name": "<string>",
"owner_id": "<string>",
"project_id": "<string>",
"rate_limit": 123,
"rate_limit_duration": 123,
"secrets": [
{
"created_at": "<string>",
"deleted_at": "<string>",
"expires_at": "<string>",
"uid": "<string>",
"updated_at": "<string>",
"value": "<string>"
}
],
"slack_webhook_url": "<string>",
"status": "active",
"support_email": "<string>",
"uid": "<string>",
"updated_at": "<string>",
"url": "<string>"
}
}
Authorizations
Response
202
application/json
Accepted
Available options:
active
, inactive
, pending
, paused
Was this page helpful?
curl --request PUT \
--url https://dashboard.getconvoy.io/api/v1/projects/{projectID}/endpoints/{endpointID}/pause \
--header 'Authorization: <api-key>'
{
"message": "<string>",
"status": true,
"data": {
"advanced_signatures": true,
"authentication": {
"api_key": {
"header_name": "<string>",
"header_value": "<string>"
},
"type": "api_key"
},
"created_at": "<string>",
"deleted_at": "<string>",
"description": "<string>",
"events": 123,
"failure_rate": 123,
"http_timeout": 123,
"name": "<string>",
"owner_id": "<string>",
"project_id": "<string>",
"rate_limit": 123,
"rate_limit_duration": 123,
"secrets": [
{
"created_at": "<string>",
"deleted_at": "<string>",
"expires_at": "<string>",
"uid": "<string>",
"updated_at": "<string>",
"value": "<string>"
}
],
"slack_webhook_url": "<string>",
"status": "active",
"support_email": "<string>",
"uid": "<string>",
"updated_at": "<string>",
"url": "<string>"
}
}