Skip to main content
POST
/
v1
/
projects
/
{projectID}
/
endpoints
/
{endpointID}
/
activate
Activate endpoint
curl --request POST \
  --url https://us.getconvoy.cloud/api/v1/projects/{projectID}/endpoints/{endpointID}/activate \
  --header 'Authorization: <api-key>'
{
  "message": "<string>",
  "status": true,
  "data": {
    "advanced_signatures": true,
    "authentication": {
      "api_key": {
        "header_name": "<string>",
        "header_value": "<string>"
      },
      "basic_auth": {
        "password": "<string>",
        "username": "<string>"
      },
      "oauth2": {
        "audience": "<string>",
        "authentication_type": "shared_secret",
        "client_id": "<string>",
        "client_secret": "<string>",
        "expiry_time_unit": "seconds",
        "field_mapping": {
          "access_token": "<string>",
          "expires_in": "<string>",
          "token_type": "<string>"
        },
        "grant_type": "<string>",
        "issuer": "<string>",
        "scope": "<string>",
        "signing_algorithm": "<string>",
        "signing_key": {
          "crv": "<string>",
          "d": "<string>",
          "dp": "<string>",
          "dq": "<string>",
          "e": "<string>",
          "kid": "<string>",
          "kty": "<string>",
          "n": "<string>",
          "p": "<string>",
          "q": "<string>",
          "qi": "<string>",
          "x": "<string>",
          "y": "<string>"
        },
        "subject": "<string>",
        "url": "<string>"
      },
      "type": "api_key"
    },
    "content_type": "<string>",
    "created_at": "<string>",
    "deleted_at": "<string>",
    "description": "<string>",
    "events": 123,
    "failure_rate": 123,
    "http_timeout": 123,
    "mtls_client_cert": {
      "client_cert": "<string>",
      "client_key": "<string>"
    },
    "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

Response

Accepted

message
string
status
boolean
data
object