Endpoints
Roll endpoint secret
- Community
- GitHub
- Tutorials
- GETList all endpoints
- POSTCreate an endpoint
- GETRetrieve endpoint
- PUTUpdate an endpoint
- DELDelete endpoint
- PUTRoll endpoint secret
- PUTPause endpoint
- GETList all event deliveries
- POSTBatch retry event delivery
- POSTForce retry event delivery
- GETRetrieve an event delivery
- PUTRetry event delivery
- GETList all events
- POSTCreate an event
- POSTCreate a broadcast event
- POSTBatch replay events
- POSTDynamic Events
- POSTFan out an event
- GETRetrieve an event
- PUTReplay event
- GETList all portal links
- POSTCreate a portal link
- GETRetrieve a portal link
- PUTUpdate a portal link
- PUTRevoke a portal link
Endpoints
Event Deliveries
Events
Portal Links
Endpoints
Roll endpoint secret
This endpoint expires and re-generates the endpoint secret.
PUT
/
v1
/
projects
/
{projectID}
/
endpoints
/
{endpointID}
/
expire_secret
Authorization
string
*
Authorization
Required
string
projectID
string
*
projectID
Required
string
Project ID
endpointID
string
*
endpointID
Required
string
Endpoint ID
object
*
expiration
integer
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
secret
string
New Endpoint secret value.
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,
"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
headerrequiredPath Parameters
projectID
string
requiredProject ID
endpointID
string
requiredEndpoint ID
Body
application/json
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
message
string
status
boolean
data
object
data.advanced_signatures
boolean
data.authentication
object
data.authentication.api_key
object
data.authentication.api_key.header_name
string
data.authentication.api_key.header_value
string
data.authentication.type
enum<string>
Available options:
api_key data.created_at
string
data.deleted_at
string
data.description
string
data.events
integer
data.http_timeout
integer
data.name
string
data.owner_id
string
data.project_id
string
data.rate_limit
integer
data.rate_limit_duration
integer
data.secrets
object[]
data.secrets.created_at
string
data.secrets.deleted_at
string
data.secrets.expires_at
string
data.secrets.uid
string
data.secrets.updated_at
string
data.secrets.value
string
data.slack_webhook_url
string
data.status
enum<string>
Available options:
active, inactive, pending, paused data.support_email
string
data.uid
string
data.updated_at
string
data.url
string
Was this page helpful?
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,
"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>"
}
}