2.5 KiB
title, intro, versions, topics, autogenerated
| title | intro | versions | topics | autogenerated | |||
|---|---|---|---|---|---|---|---|
| Management Console | Use the REST API to manage your {% data variables.product.product_name %} installation. |
|
|
rest |
About the Management Console
{% tip %}
You should explicitly set the port number when making API calls to the Management Console. If TLS is enabled on your enterprise, the port number is 8443. Otherwise, the port number is 8080.
If you cannot provide a port number, you'll need to configure your tool to automatically follow redirects.
You may also need to add the -k flag when using curl, since {% data variables.product.product_name %} uses a self-signed certificate before you add your own TLS certificate.
{% endtip %}
Authentication {% ifversion enterprise-management-console-multi-user-auth %}as the root site administrator{% endif %}
You need to pass your {% ifversion enterprise-management-console-multi-user-auth %}root site administrator{% else %}{% data variables.enterprise.management_console %}{% endif %} password as an authentication token to every endpoint in this category except "Create a license".
Use the api_key parameter to send this token with each request. For example:
curl -L 'https://HOSTNAME:ADMIN-PORT/setup/api?api_key=YOUR_PASSWORD'
You can also use standard HTTP authentication to send this token. For example:
curl -L -u "api_key:YOUR_PASSWORD" 'https://HOSTNAME:ADMIN-PORT/setup/api'
{% ifversion enterprise-management-console-multi-user-auth %}
Authentication as a {% data variables.enterprise.management_console %} user
Management Console user accounts can also authenticate to access this endpoint.
To authenticate with the password for a {% data variables.enterprise.management_console %} user account, use standard HTTP authentication. In the following example, replace YOUR_USER_NAME and YOUR_PASSWORD with the account's user name and password.
curl -L -u "YOUR_USER_NAME:YOUR_PASSWORD" 'https://HOSTNAME:ADMIN-PORT/setup/api'
{% endif %}