Skip to main content

API Credentials

To see the operations you can call with an API credential, with the roles each needs and its scope where one applies, see the API reference.

API Token​

You can generate an API Token to securely authenticate and interact with the platform APIs. API tokens allow you to perform specific actions such as managing applications, retrieving reports, or initiating scans without using your login credentials.


How to create API Token​

In this form

  • Click here to download Postman collection

    • Use the provided Postman collection to test and integrate the APIs with the generated token.
  • Fill in the required details,

    • Name: Enter a name for your token (e.g., Integration Token, DevOps Pipeline Token).

    • Expiration: Select an expiration period from the dropdown list. Once expired, the token will no longer work and a new one must be generated.

  • Select Scopes - Scopes define the level of access granted to the token.

    GroupScopeGrants
    ApplicationCreate AppCreating applications.
    ApplicationDelete AppDeleting applications.
    ApplicationGet AppFetching application details.
    ApplicationUpdate DetectionsUpdating detection status on findings.
    ApplicationAdd Issue TrackerConnecting an issue tracker to an application.
    ApplicationRemove Issue TrackerDisconnecting an issue tracker.
    ReportsGet ReportsReading vulnerability and scan reports.
    ScanInitiate ScanStarting scans.
    ScanGet Scan DetailsReading details of existing scans.
    ScanGet Scan ProfilesReading scan profiles.
    ScanManage Scan ProfilesCreating and changing scan profiles.
    ScanGet Scheduled ScansReading scan schedules.
    ScanManage Scheduled ScansCreating and changing scan schedules.
    TeamsList TeamsViewing the list of teams.
    TeamsGet Team DetailsReading a team's details.
    TeamsManage Application AccessChanging who can reach an application.
    IntegrationsGet ConnectionReading an integration connection.
    IntegrationsTest ConnectionTesting an integration connection.
    ActivityGet Activity LogsReading activity logs.

    Once all fields are completed, click Generate Token. The system will create a new token, which you can use in API requests.

    API Token

  • Get API Token.

    The system will create a new token, which you can use in API requests.

    API Token

OAuth Client Credentials​

OAuth Client Credentials provide a secure way for applications, scripts, and CI/CD pipelines to authenticate with the APIsec platform without requiring user credentials. Generate a Client ID and Client Secret, assign the required scopes, and exchange them for short-lived access tokens to securely access APIsec APIs.

How to create OAuth Client Credentials​

  • Open your browser and visit: https://<your-tenant>.apisecapps.com

  • Click on the API Credentials menu.

    API Token

  • Select OAuth Client Credentials

    API Token

  • Now you will see the OAuth Client Credentials form.

    API Token

    In this form

  • Fill in the required details,

    • Name: Enter a name for your token (e.g., Integration Token, DevOps Pipeline Token).

    • Expiration: Select an expiration period from the dropdown list. Once expired, the token will no longer work and a new one must be generated.

  • Select Scopes - Choose the permissions granted to the OAuth client. Only the selected API operations can be accessed. The scopes are the same set listed for API Tokens above.

    Once all fields are completed, click Generate Token. The system will create a new token, which you can use in API requests.

    API Token

    • The system will generate a new OAuth client credentials

      API Token