About the Secrets API
The Secrets API allows you to manage secrets and perform some backend functions such as sealing and unsealing the Secret Store. It offers more functionality than the DC/OS web interface.
Request and response format
The API supports JSON only. You must include
application/json as your
Content-Type in the HTTP header, as shown below.
Host name and base path
The host name to use varies according to where your app is running.
/secrets/v1/<api_endpoint> to the host name, as shown below.
Authentication and authorization
About authentication and authorization
All Secrets API endpoints require an authentication token.
Obtaining an authentication token
Via the IAM API
To get an authentication token, pass the user name and password of a
superuser in the body of a request to the
/auth/login endpoint of the Identity and Access Management Service API. It returns an authentication token as shown below.
Via the DC/OS CLI
When you log into the DC/OS CLI using
dcos auth login, it stores the authentication token value locally. You can reference this value as a variable in curl commands (discussed in the next section).
Alternatively, you can use the following command to get the authentication token value.
dcos config show core.dcos_acs_token
Passing an authentication token
Copy the token value and pass it in the
Authorization field of the HTTP header, as shown below.
Via curl as a string value
Using curl, for example, you would pass this value as follows.
curl -H "Authorization: token=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1aWQiOiJib290c3RyYXB1c2VyIiwiZXhwIjoxNDgyNjE1NDU2fQ.j3_31keWvK15shfh_BII7w_10MgAj4ay700Rub5cfNHyIBrWOXbedxdKYZN6ILW9vLt3t5uCAExOOFWJkYcsI0sVFcM1HSV6oIBvJ6UHAmS9XPqfZoGh0PIqXjE0kg0h0V5jjaeX15hk-LQkp7HXSJ-V7d2dXdF6HZy3GgwFmg0Ayhbz3tf9OWMsXgvy_ikqZEKbmPpYO41VaBXCwWPmnP0PryTtwaNHvCJo90ra85vV85C02NEdRHB7sqe4lKH_rnpz980UCmXdJrpO4eTEV7FsWGlFBuF5GAy7_kbAfi_1vY6b3ufSuwiuOKKunMpas9_NfDe7UysfPVHlAxJJgg"
Via curl as a DC/OS CLI variable
You can then reference this value in your curl commands, as shown below.
curl -H "Authorization: token=$(dcos config show core.dcos_acs_token)"
Refreshing the authentication token
Authentication tokens expire after five days by default. If your program needs to run longer than five days, you will need a service account. Please see Provisioning custom services for more information.
While the API returns informative error messages, you may also find it useful to check the logs of the service. Refer to Service and Task Logging for instructions