Early Access Preview

NGINX One is currently available in Early Access. This preview version is for evaluation and testing purposes only and should not be used in production environments.

Authentication

In this guide, we’ll show you how to authenticate API requests with F5 Distributed Cloud. There are two options for authentication: API Token or API Certificate. Both methods ensure secure access to your data.

Getting ready

Before you begin, make sure you have either an API Token or API Certificate for authentication. You can get these from the F5 Distributed Cloud Console. Visit the following link for instructions:

Authentication methods

You can authenticate API requests in two ways: using an API Token or an API Certificate. Below are examples of how to do this with curl, but you can also use other tools like Postman.

See Also:
For definitions of terms such as ’tenant’ and ’namespace’ used in the following examples, refer to the NGINX One Glossary.

  1. API Token Authentication: An API token grants a user access to the NGINX One REST API. The user’s role determines the permissions associated with the API token. Include the token in the Authorization request header.

    Here’s how to use an API token to authenticate a request to the F5 Distributed Cloud API. This example request lists tenant namespaces for organization plans:

    curl https://<tenant>.console.ves.volterra.io/api/web/namespaces \
-H "Authorization: APIToken <token-value>"
    • <tenant>: Your tenant name for organization plans.
    • <token-value> Your API Token.

  2. API Certificate Authentication: Include the client certificate and password in the request. For organization plans:

    curl https://<tenant>.console.ves.volterra.io/api/web/namespaces --cert-type P12 \
--cert <api-creds>:<password>
    • <tenant>: Your tenant name for organization plans.
    • <api-creds>: The path to your certificate file. It’s best to use the full path of the certificate.
    • <password> Your certificate password.

Constructing a request

NGINX One API requests should follow this URL format:

https://<tenant>.console.ves.volterra.io/api/nginx/one/namespaces/{namespace}/{kind}
  • <tenant>: Your tenant name for organization plans.
  • {namespace}: The namespace your object belongs to.
  • {kind}: The type of object you’re dealing with.

For instance, to list all NGINX One ‘data-plane-key’ objects in the ‘default’ namespace, use:

curl https://<tenant>.console.ves.volterra.io/api/nginx/one/namespaces/default/data-plane-keys \
-H "Authorization: APIToken <token-value>"

Further reading