Endpoint addresses for operations
This is the interface by which the client contacts ADM for operations. ADM provides a REST API for HTTPS or HTTP.
By default, the application endpoint will use port 8080 and the administration endpoint will use port 8081. The properties for applicationConnectors and adminConnectors can be configured to use specific ports in the deployment configuration YAML file as described in Application and administration endpoints.
Application endpoints
The application endpoints are configured at the applicationConnectors property in the configuration YAML file (refer to docker/resources/deployment.yaml or the additional resources section Configuration sample files).
The following endpoints can be used:
| Operation | Method | URI | Description |
|---|---|---|---|
| Retrieve domain by id | GET | /api/domains/<domain_id> | A method of retrieval primarily used for auditing. |
| Retrieve domain by name | GET | /api/namespaces/<namespace>/names/<domain_name>/domain | This is the primary method of retrieval. It retrieves a specific domain within a namespace. |
| Retrieve domain names | GET | /api/namespaces/<namespace>/names | This operation returns a list of the domain names that belong to the same namespace. |
| Retrieve domain name history | GET | /api/namespaces/<namespace>/names/<domain_name>/history | This operation returns an array of the historical changes of this domain name in the form of pairs of dates and domain IDs sorted by time. |
| Roll back a domain name change | POST | /api/namespaces/<namespace>/names/<domain_name>/rollback/<domain_id> | This operation points the domain name to the domain ID in the argument, thereby restoring it to a previous state. |
| Store domain | POST | /api/namespaces/<namespace>/names/<domain_name> | Once stored the domain is always retrievable. Domains cannot be deleted. If the domain of a namespace is deleted or overwritten it is still retrievable by the domain identifier. |
| Delete name | DELETE | /api/namespaces/<namespace>/names/<domain_name> | This deletes only the mapping of the name from the namespace. |
| Delete namespace | DELETE | /api/namespaces/<namespace>/ | This deletes a namespace along with its domain members and its history. |
| Copy name | PUT | /api/namespaces/<namespace>/names/<sourceName>/copy/<destinationName> | Copy the contents of a domain to another domain in the same namespace. |
The length of a <namespace> is limited to 500 characters, as is the length of a <domain_name>.
Swagger UI
The ADM API is also documented using Swagger UI. More information for each operation is available via:
https://<host:applicationConnectorsPort>/swagger-ui/
For example:
https://localhost:8080/swagger-ui/
Administration endpoints
The administration endpoints are configured at the adminConnectors property in the configuration YAML file (cf. docker/resources/deployment.yaml or the additional resources section Configuration sample files).
GET http://localhost:8081/healthcheck (an endpoint to determine the state of the application)
For an example of the healthcheck in use, see Checking that ADM is running.
See Application and administration endpoints for more configuration information.