API summary

See the API's various operations for details on their request parameters and response data.

OperationMethodEndpoint
API endpoints
Register an endpointPOST/endpoints
List endpointsGET/endpoints
Clone an endpointPOST/endpoints/​cloneEndpoint
Register an endpoint from an API definition filePOST/endpoints/​files
List user entitlementsGET/endpoints/​user-entitlements
Verify secure connectionPOST/endpoints/​verify-secure-connection
Delete an endpointDELETE/endpoints/​{apiEndPointId}
Hide an endpointPOST/endpoints/​{apiEndPointId}/​hide
Show an endpointPOST/endpoints/​{apiEndPointId}/​show
List versionsGET/endpoints/​{apiEndPointId}/​versions
Get a version summaryGET/endpoints/​{apiEndPointId}/​versions/​{versionNumber}
Edit a versionPUT/endpoints/​{apiEndPointId}/​versions/​{versionNumber}
Delete a versionDELETE/endpoints/​{apiEndPointId}/​versions/​{versionNumber}
Activate a versionPOST/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​activate
Clone a versionPOST/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​cloneVersion
Deactivate a versionPOST/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​deactivate
Edit an endpoint from an API definition filePOST/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​file
Hide a versionPOST/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​hide
List parameters with PII for an endpoint versionGET/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​piis
Add or update a user-created PII instancePOST/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​piis/​parameters/​{paramId}
Modify PII settings for an endpoint versionPOST/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​piis/​settings
List PII settings for an endpoint versionGET/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​piis/​settings
Modify PII status per endpoint versionPOST/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​piis/​status
Delete PII in an endpoint versionDELETE/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​piis/​{piiId}
Patch PII status per endpoint versionPATCH/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​piis/​{piiId}/​status
Create a resourcePOST/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​resources
List resourcesGET/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​resources
Get a versionGET/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​resources-detail
Get a resourceGET/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​resources/​{apiResourceId}
Edit a resourcePUT/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​resources/​{apiResourceId}
Delete a resourceDELETE/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​resources/​{apiResourceId}
Show a versionPOST/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​show
Categories
Create a categoryPOST/categories
List categoriesGET/categories
Get a categoryGET/categories/​{apiCategoryId}
Edit a categoryPUT/categories/​{apiCategoryId}
Delete a categoryDELETE/categories/​{apiCategoryId}
Contracts and groups
List contracts and groupsGET/contracts/​groups
List hostnamesGET/contracts/​{contractId}/​groups/​{groupId}/​hosts
List hostnames with access control groupsGET/contracts/​{contractId}/​groups/​{groupId}/​hostsAcgs
API delivery settings
Get API privacy settingsGET/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​settings/​api-privacy
Edit API privacy settingsPUT/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​settings/​api-privacy
Get cache settingsGET/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​settings/​cache
Edit cache settingsPUT/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​settings/​cache
Get CORS settingsGET/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​settings/​cors
Edit CORS settingsPUT/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​settings/​cors
Get error response settingsGET/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​settings/​error-responses
Edit error response settingsPUT/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​settings/​error-responses
Get an error responseGET/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​settings/​error-responses/​{type}
Edit an error responsePUT/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​settings/​error-responses/​{type}
Get GraphQL cache settingsGET/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​settings/​graphql
Edit GraphQL cache settingsPUT/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​settings/​graphql
Get GZIP settingsGET/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​settings/​gzip
Edit GZIP settingsPUT/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​settings/​gzip
Get JWT settingsGET/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​settings/​jwt
Edit JWT settingsPUT/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​settings/​jwt
Get routing settingsGET/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​settings/​routing
Edit routing settingsPUT/endpoints/​{apiEndPointId}/​versions/​{versionNumber}/​settings/​routing