PUT
/
v1
/
projects
/
{projectID}
/
endpoints
/
{endpointID}
/
expire_secret
curl --request PUT \
  --url https://dashboard.getconvoy.io/api/v1/projects/{projectID}/endpoints/{endpointID}/expire_secret \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "expiration": 123,
  "secret": "<string>"
}'
{
  "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

​
Authorization
string
header
required

Path Parameters

​
projectID
string
required

Project ID

​
endpointID
string
required

Endpoint ID

Body

application/json
Expire Secret Body Parameters
​
expiration
integer

Amount of time to wait before expiring the old endpoint secret. If AdvancedSignatures is turned on for the project, signatures for both secrets will be generated up until the old signature is expired.

​
secret
string

New Endpoint secret value.

Response

200
application/json
OK
​
message
string
​
status
boolean
​
data
object

Was this page helpful?

Delete endpointPause endpoint