Get campaign.

GET

/backend/v1/campaigns/{campaignId}

Retrieves a campaign by its ID.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

campaignId*

Type

string

Required

Format

"uuid"

Query Parameters

configAt

Get the config at a given point in time.

Responses

Successful Response

Content-Type

application/json

{

  

"campaign": {

  

  

"attacks": [

  

  

  

{

  

  

  

  

{

  

  

  

  

  

"fileId": "string",

  

  

  

  

  

"name": "string",

  

  

  

  

  

"severity": 1,

  

  

  

  

  

"technique": "custom"

  

  

  

  

}

  

  

  

}

  

  

],

  

  

"createdAt": "string",

  

  

"createdBy": "string",

  

  

"description": "string",

  

  

"id": "string",

  

  

"lastRun": "string",

  

  

"lastRunAt": "string",

  

  

"name": "string",

  

  

"runCount": 0,

  

  

"vendored": false

  

}

}

GET

/backend/v1/campaigns/{campaignId}

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

campaignId*

configAt

Samples

Powered by VitePress OpenAPI