See the API's various operations for details on their request parameters and response data.
| Operation | Method | Endpoint |
|---|---|---|
| Contracts and groups | ||
| List contracts and groups | GET | /contracts/groups |
| List hostnames | GET | /contracts/{contractId}/groups/{groupId}/hosts |
| List hostnames with access control groups | GET | /contracts/{contractId}/groups/{groupId}/hostsAcgs |
| Categories | ||
| List categories | GET | /categories |
| Create a category | POST | /categories |
| Delete a category | DELETE | /categories/{apiCategoryId} |
| Get a category | GET | /categories/{apiCategoryId} |
| Edit a category | PUT | /categories/{apiCategoryId} |
| API endpoints | ||
| List endpoints | GET | /endpoints |
| Register an endpoint | POST | /endpoints |
| Clone an endpoint | POST | /endpoints/cloneEndpoint |
| Register an endpoint from an API definition file | POST | /endpoints/files |
| List user entitlements | GET | /endpoints/user-entitlements |
| Verify secure connection | POST | /endpoints/verify-secure-connection |
| Delete an endpoint | DELETE | /endpoints/{apiEndPointId} |
| Hide an endpoint | POST | /endpoints/{apiEndPointId}/hide |
| Show an endpoint | POST | /endpoints/{apiEndPointId}/show |
| List versions | GET | /endpoints/{apiEndPointId}/versions |
| Delete a version | DELETE | /endpoints/{apiEndPointId}/versions/{versionNumber} |
| Get a version summary | GET | /endpoints/{apiEndPointId}/versions/{versionNumber} |
| Edit a version | PUT | /endpoints/{apiEndPointId}/versions/{versionNumber} |
| Activate a version | POST | /endpoints/{apiEndPointId}/versions/{versionNumber}/activate |
| Clone a version | POST | /endpoints/{apiEndPointId}/versions/{versionNumber}/cloneVersion |
| Deactivate a version | POST | /endpoints/{apiEndPointId}/versions/{versionNumber}/deactivate |
| Edit an endpoint from an API definition file | POST | /endpoints/{apiEndPointId}/versions/{versionNumber}/file |
| Hide a version | POST | /endpoints/{apiEndPointId}/versions/{versionNumber}/hide |
| List parameters with PII for an endpoint version | GET | /endpoints/{apiEndPointId}/versions/{versionNumber}/piis |
| Add or update a user-created PII instance | POST | /endpoints/{apiEndPointId}/versions/{versionNumber}/piis/parameters/{paramId} |
| List PII settings for an endpoint version | GET | /endpoints/{apiEndPointId}/versions/{versionNumber}/piis/settings |
| Modify PII settings for an endpoint version | POST | /endpoints/{apiEndPointId}/versions/{versionNumber}/piis/settings |
| Modify PII status per endpoint version | POST | /endpoints/{apiEndPointId}/versions/{versionNumber}/piis/status |
| Delete PII in an endpoint version | DELETE | /endpoints/{apiEndPointId}/versions/{versionNumber}/piis/{piiId} |
| Patch PII status per endpoint version | PATCH | /endpoints/{apiEndPointId}/versions/{versionNumber}/piis/{piiId}/status |
| List resources | GET | /endpoints/{apiEndPointId}/versions/{versionNumber}/resources |
| Create a resource | POST | /endpoints/{apiEndPointId}/versions/{versionNumber}/resources |
| Get a version | GET | /endpoints/{apiEndPointId}/versions/{versionNumber}/resources-detail |
| Delete a resource | DELETE | /endpoints/{apiEndPointId}/versions/{versionNumber}/resources/{apiResourceId} |
| Get a resource | GET | /endpoints/{apiEndPointId}/versions/{versionNumber}/resources/{apiResourceId} |
| Edit a resource | PUT | /endpoints/{apiEndPointId}/versions/{versionNumber}/resources/{apiResourceId} |
| Show a version | POST | /endpoints/{apiEndPointId}/versions/{versionNumber}/show |
| API delivery settings | ||
| Get API privacy settings | GET | /endpoints/{apiEndPointId}/versions/{versionNumber}/settings/api-privacy |
| Edit API privacy settings | PUT | /endpoints/{apiEndPointId}/versions/{versionNumber}/settings/api-privacy |
| Get cache settings | GET | /endpoints/{apiEndPointId}/versions/{versionNumber}/settings/cache |
| Edit cache settings | PUT | /endpoints/{apiEndPointId}/versions/{versionNumber}/settings/cache |
| Get CORS settings | GET | /endpoints/{apiEndPointId}/versions/{versionNumber}/settings/cors |
| Edit CORS settings | PUT | /endpoints/{apiEndPointId}/versions/{versionNumber}/settings/cors |
| Get error response settings | GET | /endpoints/{apiEndPointId}/versions/{versionNumber}/settings/error-responses |
| Edit error response settings | PUT | /endpoints/{apiEndPointId}/versions/{versionNumber}/settings/error-responses |
| Get an error response | GET | /endpoints/{apiEndPointId}/versions/{versionNumber}/settings/error-responses/{type} |
| Edit an error response | PUT | /endpoints/{apiEndPointId}/versions/{versionNumber}/settings/error-responses/{type} |
| Get GraphQL cache settings | GET | /endpoints/{apiEndPointId}/versions/{versionNumber}/settings/graphql |
| Edit GraphQL cache settings | PUT | /endpoints/{apiEndPointId}/versions/{versionNumber}/settings/graphql |
| Get GZIP settings | GET | /endpoints/{apiEndPointId}/versions/{versionNumber}/settings/gzip |
| Edit GZIP settings | PUT | /endpoints/{apiEndPointId}/versions/{versionNumber}/settings/gzip |
| Get JWT settings | GET | /endpoints/{apiEndPointId}/versions/{versionNumber}/settings/jwt |
| Edit JWT settings | PUT | /endpoints/{apiEndPointId}/versions/{versionNumber}/settings/jwt |
| Get routing settings | GET | /endpoints/{apiEndPointId}/versions/{versionNumber}/settings/routing |
| Edit routing settings | PUT | /endpoints/{apiEndPointId}/versions/{versionNumber}/settings/routing |
| Resources and operations | ||
| List resources and operations | GET | /endpoints/{endpointId}/versions/{versionNumber}/resources-and-operations |
| List resource operations | GET | /endpoints/{endpointId}/versions/{versionNumber}/resources/{apiResourceId}/operations |
| Create a resource operation | POST | /endpoints/{endpointId}/versions/{versionNumber}/resources/{apiResourceId}/operations |
| Delete a resource operation | DELETE | /endpoints/{endpointId}/versions/{versionNumber}/resources/{apiResourceId}/operations/{operationId} |
| Get a resource operation | GET | /endpoints/{endpointId}/versions/{versionNumber}/resources/{apiResourceId}/operations/{operationId} |
| Update a resource operation | PUT | /endpoints/{endpointId}/versions/{versionNumber}/resources/{apiResourceId}/operations/{operationId} |
| Search operations | GET | /search-operations |
| Query operations | POST | /search-operations |
| Verify existing operations | POST | /verify-operations |
| Multistep groups | ||
| List multistep group details | GET | /endpoints/{endpointId}/versions/{versionNumber}/multistep-groups |
| Create a multistep group | POST | /endpoints/{endpointId}/versions/{versionNumber}/multistep-groups |
| Delete a multistep group | DELETE | /endpoints/{endpointId}/versions/{versionNumber}/multistep-groups/{multistepGroupId} |
| Get a multistep group | GET | /endpoints/{endpointId}/versions/{versionNumber}/multistep-groups/{multistepGroupId} |
| Update a multistep group | PUT | /endpoints/{endpointId}/versions/{versionNumber}/multistep-groups/{multistepGroupId} |