API summary

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

OperationMethodEndpoint
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
Endpoints
List endpointsGET/endpoints
Register an endpointPOST/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
Versions
List versionsGET/endpoints/‚Äč{apiEndPointId}/‚Äčversions
Delete a versionDELETE/endpoints/‚Äč{apiEndPointId}/‚Äčversions/‚Äč{versionNumber}
Get a version summaryGET/endpoints/‚Äč{apiEndPointId}/‚Äčversions/‚Äč{versionNumber}
Edit a versionPUT/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
Show a versionPOST/endpoints/‚Äč{apiEndPointId}/‚Äčversions/‚Äč{versionNumber}/‚Äčshow
Resources
List resourcesGET/endpoints/‚Äč{apiEndPointId}/‚Äčversions/‚Äč{versionNumber}/‚Äčresources
Create a resourcePOST/endpoints/‚Äč{apiEndPointId}/‚Äčversions/‚Äč{versionNumber}/‚Äčresources
Get a versionGET/endpoints/‚Äč{apiEndPointId}/‚Äčversions/‚Äč{versionNumber}/‚Äčresources-detail
Delete a resourceDELETE/endpoints/‚Äč{apiEndPointId}/‚Äčversions/‚Äč{versionNumber}/‚Äčresources/‚Äč{apiResourceId}
Get a resourceGET/endpoints/‚Äč{apiEndPointId}/‚Äčversions/‚Äč{versionNumber}/‚Äčresources/‚Äč{apiResourceId}
Edit a resourcePUT/endpoints/‚Äč{apiEndPointId}/‚Äčversions/‚Äč{versionNumber}/‚Äčresources/‚Äč{apiResourceId}
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
Categories
List categoriesGET/categories
Delete a categoryDELETE/categories/‚Äč{apiCategoryId}
Get a categoryGET/categories/‚Äč{apiCategoryId}
Edit a categoryPUT/categories/‚Äč{apiCategoryId}