Quickstart

This guide takes you from zero to your first authenticated response. It assumes you already have a Secfix workspace.

Create an API key

In the Secfix web app, go to Settings → API and create an API key. Give it a name and grant it the access it needs — for this guide, Read access (all:read).You receive a client_id and a client_secret. The secret is shown once — copy it somewhere safe. See Managing API keys for the full flow.

Exchange your credentials for a token

Call the token endpoint with the OAuth 2.0 client_credentials grant:

curl -X POST https://api.secfix.com/oauth/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=YOUR_CLIENT_SECRET"

Response

{
  "access_token": "eyJhbGciOi...",
  "token_type": "Bearer",
  "expires_in": 86400
}

Cache this token and reuse it until it expires — see Rate limits. Full details in Authentication.

Call your first endpoint

Send the access token as a bearer token to list your asset inventory:

curl "https://api.secfix.com/v1/inventory/assets?pageSize=25" \
  -H "Authorization: Bearer eyJhbGciOi..."

Response

{
  "results": [
    {
      "id": "3f1c9a2e-8b4d-4e7a-9c1f-2a5b6c7d8e9f",
      "name": "prod-db-01",
      "categoryKey": "CLOUD",
      "classification": "CONFIDENTIAL",
      "completeStatus": "COMPLETE"
    }
  ],
  "pageInfo": {
    "hasNextPage": true,
    "endCursor": "eyJjIjoiMjAyNi0wNi0zMFQwMjowMDowMFoi.."
  }
}

Paginate through results

Keep passing pageInfo.endCursor as pageCursor while pageInfo.hasNextPage is true:

curl "https://api.secfix.com/v1/inventory/assets?pageSize=25&pageCursor=eyJj..." \
  -H "Authorization: Bearer eyJhbGciOi..."

See Pagination for the full contract.

Next steps

Authentication

Token lifetime, the single-active-token rule, and tenancy.

Scopes

Which permissions each endpoint requires.

Work with inventory

Filter assets and update governance metadata.

API reference

Browse every endpoint interactively.

Get started

Core concepts

Guides

Next steps

Authentication

Scopes

Work with inventory

API reference

​Next steps

Authentication

Scopes

Work with inventory

API reference

Next steps