Skip to navigation
API ReferenceApplications

Create an application

Requires the inventory:write API key scope.

Authentication

AuthorizationBearer

A workspace API key, sent as Authorization: Bearer.

OR
x-api-keystring

A workspace API key, sent as x-api-key.

Request

This endpoint expects an object.
namestringRequired
descriptionstringRequired
typeenumOptional
frameworkstringOptional
domainIdstring or nullOptionalformat: "uuid"
disallowedActionsstringOptional
Actions the testing agent must not perform.

Response

The created application.
idstringformat: "uuid"
namestring
typeenum or null
frameworkstring or null
workspaceIdstringformat: "uuid"
domainIdstring or nullformat: "uuid"
domainUrlstring or null
createdAtdatetime
descriptionstring
disallowedActionsstring or null

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error