See the API's various operations for details on their request parameters and response data:
You can also run this API with a Postman collection.
| Operation | Method | Endpoint |
|---|---|---|
| Enrollments | ||
| List enrollments | GET | /enrollments |
| Create an enrollment | POST | /enrollments |
| Remove an enrollment | DELETE | /enrollments/{enrollmentId} |
| Get an enrollment | GET | /enrollments/{enrollmentId} |
| Update an enrollment | PUT | /enrollments/{enrollmentId} |
| Get DV history | GET | /enrollments/{enrollmentId}/dv-history |
| Get certificate history | GET | /enrollments/{enrollmentId}/history/certificates |
| Changes | ||
| Cancel a change | DELETE | /enrollments/{enrollmentId}/changes/{changeId} |
| Get change status | GET | /enrollments/{enrollmentId}/changes/{changeId} |
| Get a deployment schedule | GET | /enrollments/{enrollmentId}/changes/{changeId}/deployment-schedule |
| Get change history | GET | /enrollments/{enrollmentId}/history/changes |
| Get a change | GET | /enrollments/{enrollmentId}/changes/{changeId}/input/info/{allowedInputTypeParam} |
| Update a change | POST | /enrollments/{enrollmentId}/changes/{changeId}/input/update/{allowedInputTypeParam} |
| Deployments | ||
| Update a deployment schedule | PUT | /enrollments/{enrollmentId}/changes/{changeId}/deployment-schedule |
| List deployments | GET | /enrollments/{enrollmentId}/deployments |
| Get production deployment | GET | /enrollments/{enrollmentId}/deployments/production |
| Get staging deployment | GET | /enrollments/{enrollmentId}/deployments/staging |