AIaikido

List endpoint exceptions

Returns a list of all the endpoint protection exceptions

get/endpoint-protection/{ecosystem}/exceptions

Request

  • Base URL
    https://app.aikido.dev/api/public/v1
  • URL
    https://app.aikido.dev/api/public/v1/endpoint-protection/{ecosystem}/exceptions
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://app.aikido.io/api/oauth/token scopes: endpoint_protection:read

Path parameters

ecosystem'npm' | 'pypi' | 'vscode' | 'open_vsx' | 'maven' | 'nuget' | 'chrome' | 'golang' | 'skills_sh' required

The ecosystem to list the exceptions for

Response

A list of all the endpoint protection exceptions for an ecosystem

idinteger

The ID of the exception

ecosystemstring

The ecosystem of the exception

package_namestring

The name of the package

status'allowed' | 'blocked'

The status of the exception. 'allowed' means the package is allowed to be installed, 'blocked' means the package is blocked from being installed.

permission_group_idinteger

The ID of the permission group related to the exception

permission_group_namestring

The name of the permission group related to the exception

bypass_default_minimum_allowed_ageboolean

Whether the exception bypasses the default minimum allowed age on installation. This is only applicable for allowed exceptions.

Example response

[
  {
    "id": 1,
    "ecosystem": "npm",
    "package_name": "lodash",
    "status": "allowed",
    "permission_group_id": 1,
    "permission_group_name": "Default",
    "bypass_default_minimum_allowed_age": false
  },
  {
    "id": 2,
    "ecosystem": "npm",
    "package_name": "lodash",
    "status": "blocked",
    "permission_group_id": 2,
    "permission_group_name": "Sales"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.