Delegate Download Resource

Contains APIs related to Downloading Delegates

Downloads a docker delegate yaml file.

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

Request Body schema: application/json
required

Parameters needed for downloading docker delegate yaml

name
required
string
description
string
size
string
Enum: "LAPTOP" "SMALL" "MEDIUM" "LARGE" "CCM_SMALL"
tags
Array of strings unique
tokenName
string
clusterPermissionType
string
Enum: "CLUSTER_ADMIN" "CLUSTER_VIEWER" "NAMESPACE_ADMIN"
customClusterNamespace
string
Responses
400

Bad Request

500

Internal server error

default

Delegate Yaml File.

post/ng/api/download-delegates/docker
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "size": "LAPTOP",
  • "tags": [
    ],
  • "tokenName": "string",
  • "clusterPermissionType": "CLUSTER_ADMIN",
  • "customClusterNamespace": "string"
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Downloads a kubernetes delegate yaml file.

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

Request Body schema: application/json
required

Parameters needed for downloading kubernetes delegate yaml

name
required
string
description
string
size
string
Enum: "LAPTOP" "SMALL" "MEDIUM" "LARGE" "CCM_SMALL"
tags
Array of strings unique
tokenName
string
clusterPermissionType
string
Enum: "CLUSTER_ADMIN" "CLUSTER_VIEWER" "NAMESPACE_ADMIN"
customClusterNamespace
string
Responses
400

Bad Request

500

Internal server error

default

Delegate Yaml File.

post/ng/api/download-delegates/kubernetes
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "size": "LAPTOP",
  • "tags": [
    ],
  • "tokenName": "string",
  • "clusterPermissionType": "CLUSTER_ADMIN",
  • "customClusterNamespace": "string"
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}