Endpoints
List all endpoints
- 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
List all endpoints
This endpoint fetches an endpoints
GET
/
v1
/
projects
/
{projectID}
/
endpoints
Authorization
string
*
Authorization
Required
string
projectID
string
*
projectID
Required
string
Project ID
direction
enum<string>
direction
enum<string>
next_page_cursor
string
next_page_cursor
string
A pagination cursor to fetch the next page of a list
ownerId
string
ownerId
string
The owner ID of the endpoint
perPage
integer
perPage
integer
The number of items to return per page
prev_page_cursor
string
prev_page_cursor
string
A pagination cursor to fetch the previous page of a list
q
string
q
string
The name of the endpoint
sort
string
sort
string
Sort order, values are ASC or DESC, defaults to DESC
curl --request GET \
--url https://dashboard.getconvoy.io/api/v1/projects/{projectID}/endpoints \
--header 'Authorization: <api-key>'{
"message": "<string>",
"status": true,
"data": {
"content": [
{
"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>"
}
],
"pagination": {
"has_next_page": true,
"has_prev_page": true,
"next_page_cursor": "<string>",
"per_page": 123,
"prev_page_cursor": "<string>"
}
}
}Authorizations
Authorization
string
headerrequiredPath Parameters
projectID
string
requiredProject ID
Query Parameters
direction
enum<string>
Available options:
next, prev next_page_cursor
string
A pagination cursor to fetch the next page of a list
ownerId
string
The owner ID of the endpoint
perPage
integer
The number of items to return per page
prev_page_cursor
string
A pagination cursor to fetch the previous page of a list
q
string
The name of the endpoint
sort
string
Sort order, values are ASC or DESC, defaults to DESC
Response
200 - application/json
message
string
status
boolean
data
object
data.content
object[]
data.content.advanced_signatures
boolean
data.content.authentication
object
data.content.authentication.api_key
object
data.content.authentication.api_key.header_name
string
data.content.authentication.api_key.header_value
string
data.content.authentication.type
enum<string>
Available options:
api_key data.content.created_at
string
data.content.deleted_at
string
data.content.description
string
data.content.events
integer
data.content.http_timeout
integer
data.content.name
string
data.content.owner_id
string
data.content.project_id
string
data.content.rate_limit
integer
data.content.rate_limit_duration
integer
data.content.secrets
object[]
data.content.secrets.created_at
string
data.content.secrets.deleted_at
string
data.content.secrets.expires_at
string
data.content.secrets.uid
string
data.content.secrets.updated_at
string
data.content.secrets.value
string
data.content.slack_webhook_url
string
data.content.status
enum<string>
Available options:
active, inactive, pending, paused data.content.support_email
string
data.content.uid
string
data.content.updated_at
string
data.content.url
string
data.pagination
object
data.pagination.has_next_page
boolean
data.pagination.has_prev_page
boolean
data.pagination.next_page_cursor
string
data.pagination.per_page
integer
data.pagination.prev_page_cursor
string
Was this page helpful?
curl --request GET \
--url https://dashboard.getconvoy.io/api/v1/projects/{projectID}/endpoints \
--header 'Authorization: <api-key>'{
"message": "<string>",
"status": true,
"data": {
"content": [
{
"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>"
}
],
"pagination": {
"has_next_page": true,
"has_prev_page": true,
"next_page_cursor": "<string>",
"per_page": 123,
"prev_page_cursor": "<string>"
}
}
}