See the API's various operations for details on their request parameters and response data.
| Operation | Method | Endpoint |
|---|---|---|
| Products | ||
| List products | GET | /products |
| Get product definition | GET | /products/{productId} |
| Contracts | ||
| List modules for a contract | GET | /contracts/{contractId}/modules |
| Workspaces | ||
| Quickstart | POST | /workspace-onboarding |
| List workspaces | GET | /workspaces |
| Create a workspace | POST | /workspaces |
| Delete a workspace | DELETE | /workspaces/{workspaceName} |
| Get a workspace | GET | /workspaces/{workspaceName} |
| Update a workspace | PUT | /workspaces/{workspaceName} |
| Get available resources | GET | /workspaces/{workspaceName}/available-resources |
| Rename a workspace | POST | /workspaces/{workspaceName}/rename |
| List variable set versions for a workspace | GET | /workspaces/{workspaceName}/variable-set/versions |
| Create a new variable set version | POST | /workspaces/{workspaceName}/variable-set/versions |
| Get a variable set version | GET | /workspaces/{workspaceName}/variable-set/versions/{version} |
| Update a variable set version | PUT | /workspaces/{workspaceName}/variable-set/versions/{version} |
| Clone a variable set version | POST | /workspaces/{workspaceName}/variable-set/versions/{version}/clone |
| Environments | ||
| List environments | GET | /workspaces/{workspaceName}/environments |
| Create an environment | POST | /workspaces/{workspaceName}/environments |
| Delete an environment | DELETE | /workspaces/{workspaceName}/environments/{environmentName} |
| Get an environment | GET | /workspaces/{workspaceName}/environments/{environmentName} |
| Update an environment | PUT | /workspaces/{workspaceName}/environments/{environmentName} |
| List environment versions | GET | /workspaces/{workspaceName}/environments/{environmentName}/versions |
| Create an environment version | POST | /workspaces/{workspaceName}/environments/{environmentName}/versions |
| Get an environment version | GET | /workspaces/{workspaceName}/environments/{environmentName}/versions/{version} |
| Update an environment version | PUT | /workspaces/{workspaceName}/environments/{environmentName}/versions/{version} |
| API to get expanded rule tree of a specific environment version in external format. | GET | /workspaces/{workspaceName}/environments/{environmentName}/versions/{version}/generated-rule-tree |
| Get validation resources | GET | /workspaces/{workspaceName}/environments/{environmentName}/versions/{version}/required-resources |
| Custom rules | ||
| List environments | GET | /workspaces/{workspaceName}/environments/{environmentName}/rule-sets |
| Create a custom rule set | POST | /workspaces/{workspaceName}/environments/{environmentName}/rule-sets |
| Delete a custom rule set | DELETE | /workspaces/{workspaceName}/environments/{environmentName}/rule-sets/{ruleSetName} |
| Get a custom rule set | GET | /workspaces/{workspaceName}/environments/{environmentName}/rule-sets/{ruleSetName} |
| Update a custom rule set | PUT | /workspaces/{workspaceName}/environments/{environmentName}/rule-sets/{ruleSetName} |
| List custom rule set versions | GET | /workspaces/{workspaceName}/environments/{environmentName}/rule-sets/{ruleSetName}/versions |
| Create a new custom rule set version | POST | /workspaces/{workspaceName}/environments/{environmentName}/rule-sets/{ruleSetName}/versions |
| Delete a custom rule set version | DELETE | /workspaces/{workspaceName}/environments/{environmentName}/rule-sets/{ruleSetName}/versions/{version} |
| Get a custom rule set version | GET | /workspaces/{workspaceName}/environments/{environmentName}/rule-sets/{ruleSetName}/versions/{version} |
| Update a custom rule set version | PUT | /workspaces/{workspaceName}/environments/{environmentName}/rule-sets/{ruleSetName}/versions/{version} |
| Edge hostnames | ||
| Create an edge hostname | POST | /edge-hostnames |
| Get an edge hostname | GET | /edge-hostnames/{edgeHostname} |
| Service hostnames | ||
| List service hostname sets | GET | /workspaces/{workspaceName}/hostname-sets |
| Create a service hostname set | POST | /workspaces/{workspaceName}/hostname-sets |
| Delete the hostname set | DELETE | /workspaces/{workspaceName}/hostname-sets/{hostnameSetName} |
| Get a hostname set | GET | /workspaces/{workspaceName}/hostname-sets/{hostnameSetName} |
| Update a service hostname set | PUT | /workspaces/{workspaceName}/hostname-sets/{hostnameSetName} |
| List service hostname set versions | GET | /workspaces/{workspaceName}/hostname-sets/{hostnameSetName}/versions |
| Create a service hostname set version | POST | /workspaces/{workspaceName}/hostname-sets/{hostnameSetName}/versions |
| Get a service hostname set version | GET | /workspaces/{workspaceName}/hostname-sets/{hostnameSetName}/versions/{version} |
| Update a hostname set version | PUT | /workspaces/{workspaceName}/hostname-sets/{hostnameSetName}/versions/{version} |
| Certificate validation | ||
| Regenerate certificate domain validation authorization | POST | /workspaces/{workspaceName}/certificate/domain-validation/authorization/regenerate |
| Resume certificate domain validation | POST | /workspaces/{workspaceName}/certificate/domain-validation/proceed |
| Activations | ||
| List activations | GET | /workspaces/{workspaceName}/activations |
| Create an activation | POST | /workspaces/{workspaceName}/activations |
| Withdraw an activation before it starts | DELETE | /workspaces/{workspaceName}/activations/{activationId} |
| Get an activation | GET | /workspaces/{workspaceName}/activations/{activationId} |
| Cancel an activation | POST | /workspaces/{workspaceName}/activations/{activationId}/cancel |
| Resume a paused activation | POST | /workspaces/{workspaceName}/activations/{activationId}/proceed |
| Batch operations | ||
| Start a batch of operations | POST | /batch |
| Get a batch of operations | GET | /batch/status/{statusId} |
| Global variable specifications | ||
| List system variables | GET | /variable-set/akamai-variables |
| List data types | GET | /variable-set/data-types |
| Get data type details | GET | /variable-set/data-types/{dataType} |