Skip to content

Get providers.

GET
/backend/v1/providers

Retrieves a list of providers that match the given criteria,
with the option to adjust the limit for more results.

Authorizations

HTTPBearer
TypeHTTP (bearer)

Parameters

Query Parameters

limit

Limits the amount of results.

Typeinteger
default10
maximum100
minimum1
addedToProjectId

Get providers added to the project

accessibleToProjectId

Get providers accessible to the project

enabledForProjectId

Get providers enabled for the project

availableGlobally

Get providers that are or are not available to all projects.

configAt

Get the config at a given point in time.

cursor

Selects page for paginated results. Pass in the next or prev attribute in the response

endpoint

ID or name of an endpoint to get active providers for.

groupId

Deprecated

redTeam

Get providers that are for red team use only.

Typeboolean
defaultfalse

Responses

Successful Response
application/json
JSON
{
"next": "string",
"prev": "string",
"providers": [
{
"availability": {
"global": false,
"projectIds": [
[
]
]
},
"hasLogo": false,
"id": "string",
"inputs": {
},
"maxRequestsPerSecond": "string",
"name": "string",
"projectId": "string",
"redTeam": false,
"requestConcurrencyLimit": "string",
"secrets": {
"additionalProperties": "string"
},
"siem": false,
"systemProviderId": "string",
"tag": "string",
"template": {
"awsAuth": "string",
"body": "string",
"headers": {
},
"json": "string",
"method": "string",
"outputs": {
},
"queryParams": {
"additionalProperties": "string"
},
"timeout": 20,
"type": "request",
"url": "string"
},
"type": "string"
}
]
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

Updated at: