ADCM API
IMPORTANT
API v1 release is now deprecated. It is still going to be supported for some time, yet the recommended release is API v2. API v1 documentation is not supported anymore.
|
You can view the generated documentation on ADCM API v2 at http://<IP address>:8000/api/v2/schema/redoc/, using the IP address of the host where the ADCM container is started.
OpenAPI 3 specification can be downloaded at http://<IP address>:8000/api/v2/schema/.
For more information and examples, please refer to the documentation.
To use ADCM API v2, you need an access token. It is a digital key that allows users to access functions of ADCM API v2. To get the access token, send the POST request to the host where the ADCM container is started.
To access protected endpoints of ADCM API v2, pass the received access token in the header of the request to the required endpoint.
The following is an example of the GET request that specifies the access token to get a list of all clusters with the curl
command:
$ curl --request GET \
--url http://10.92.40.154:8000/api/v2/clusters/ \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token 884ecc261b81563811451ed01dd45859998d893a'