dac4144086
Co-authored-by: Hirsch Singhal <1666363+hpsin@users.noreply.github.com> Co-authored-by: Jovel Crisostomo <jovel@github.com> Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> Co-authored-by: Vanessa <vgrl@github.com>
1.5 KiB
title, intro, versions, topics, miniTocMaxHeadingLevel
| title | intro | versions | topics | miniTocMaxHeadingLevel | |||
|---|---|---|---|---|---|---|---|
| Management Console | The Management Console API helps you manage your {% data variables.product.product_name %} installation. |
|
|
3 |
{% tip %}
You must 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 don't want to 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
You need to pass your Management Console password as an authentication token to every Management Console API endpoint except /setup/api/start.
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'
{% data reusables.user-settings.enterprise-admin-api-classic-pat-only %}