Skip to main content
Version: 1.3

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 under the applicationConnectors property in docker/resources/deployment.yaml as illustrated in the Configuration sample files section.

The following endpoints can be used:

  • [GET] Retrieve domain by ID

    /api/domains/{domain_id}

    A method of retrieval primarily used for auditing.

  • [GET] Retrieve domain by name

    /api/namespaces/{namespace}/names/{domain_name}/domain

    This is the primary method of retrieval. It retrieves a specific domain within a namespace.

  • [GET] Retrieve domain names

    /api/namespaces/{namespace}/names

    This operation returns a list of the domain names that belong to the same namespace.

  • [GET] Retrieve domain name history

    /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.

  • [POST] Roll back a domain name change

    /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.

  • [POST] Store domain

    /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] Delete name

    /api/namespaces/{namespace}/names/{domain_name}

    This deletes only the mapping of the name from the namespace.

  • [DELETE] Delete namespace

    /api/namespaces/{namespace}/

    This deletes a namespace along with its domain members and its history.

  • [PUT] Copy name

    /api/namespaces/{namespace}/names/{sourceName}/copy/{destinationName}

    Copy the contents of a domain to another domain in the same namespace.

Important

The length of a {namespace} is limited to 500 characters, as is the length of a {domain_name}.

Important

Special characters must be UTF-8 encoded. For example, Project 1 becomes Project%201.

Swagger UI​

The ADM API is also documented using Swagger UI. More information for each operation is available through https://{host}:{applicationConnectorsPort}/swagger-ui/.

For example:

https://localhost:8080/swagger-ui/

Administration endpoints​

The administration endpoints are configured under the adminConnectors property in docker/resources/deployment.yaml as illustrated in the Configuration sample files section.

GET http://localhost:8081/healthcheck

Endpoint to determine the state of the application

tip

For an example of healthcheck in use, see Checking that ADM is running.

Read the Application and administration endpoints section for more configuration information.