BootstrapService_CreateBootstrapAgent

POST 
/v2/sentry/bootstrap/{spec.templateRef}/agent

BootstrapService_CreateBootstrapAgent

Request

Path Parameters

spec.templateRef stringrequired

Possible values: Value must match regular expression template/[^/]+

application/json

Body

required

metadata object

Metadata of the resource

name Namerequired

name of the resource

displayName Display Name

display name of the resource

description Description

description of the resource

labels object

labels of the resource

property name* string

annotations object

annotations of the resource

property name* string

project Projectrequired

Project of the resource

organization Organization

Organization to which the resource belongs

partner Partner

Partner to which the resource belongs

spec object

token string

agentMode string

Possible values: [InCluster, OutOfCluster]

Default value: InCluster

status object
tokenState string
Possible values: [NotSet, NotRegistered, NotApproved, Approved]
Default value: NotSet
ipAddress string
lastCheckedIn date-time
fingerprint string

application/yaml

Body

required

metadata object

Metadata of the resource

name Namerequired

name of the resource

displayName Display Name

display name of the resource

description Description

description of the resource

labels object

labels of the resource

property name* string

annotations object

annotations of the resource

property name* string

project Projectrequired

Project of the resource

organization Organization

Organization to which the resource belongs

partner Partner

Partner to which the resource belongs

spec object

token string

agentMode string

Possible values: [InCluster, OutOfCluster]

Default value: InCluster

status object
tokenState string
Possible values: [NotSet, NotRegistered, NotApproved, Approved]
Default value: NotSet
ipAddress string
lastCheckedIn date-time
fingerprint string

Responses

200

A successful response.

application/json

Schema

Schema

apiVersion API Version

Default value: infra.k8smgmt.io/v3

API Version of the resource

kind Kind

Default value: BootstrapAgent

Kind of the resource

metadata object
Metadata of the resource
name Namerequired
name of the resource
displayName Display Name
display name of the resource
description Description
description of the resource
labels object
labels of the resource
property name* string
annotations object
annotations of the resource
property name* string
project Projectrequired
Project of the resource
organization Organization
Organization to which the resource belongs
partner Partner
Partner to which the resource belongs
id string
urlScope string
createdAt date-time
modifiedAt date-time
spec object

token string

templateRef string

agentMode string

Possible values: [InCluster, OutOfCluster]

Default value: InCluster

status object
tokenState string
Possible values: [NotSet, NotRegistered, NotApproved, Approved]
Default value: NotSet
ipAddress string
lastCheckedIn date-time
fingerprint string

Example (from schema)

{
  "apiVersion": "infra.k8smgmt.io/v3",
  "kind": "BootstrapAgent",
  "metadata": {
    "name": "some-name",
    "project": "defaultproject"
  },
  "spec": {
    "token": "string",
    "templateRef": "string",
    "agentMode": "InCluster"
  },
  "status": {
    "tokenState": "NotSet",
    "ipAddress": "string",
    "lastCheckedIn": "2024-02-15T00:40:10.375Z",
    "fingerprint": "string"
  }
}

application/yaml

Schema

Schema

apiVersion API Version

Default value: infra.k8smgmt.io/v3

API Version of the resource

kind Kind

Default value: BootstrapAgent

Kind of the resource

metadata object
Metadata of the resource
name Namerequired
name of the resource
displayName Display Name
display name of the resource
description Description
description of the resource
labels object
labels of the resource
property name* string
annotations object
annotations of the resource
property name* string
project Projectrequired
Project of the resource
organization Organization
Organization to which the resource belongs
partner Partner
Partner to which the resource belongs
id string
urlScope string
createdAt date-time
modifiedAt date-time
spec object

token string

templateRef string

agentMode string

Possible values: [InCluster, OutOfCluster]

Default value: InCluster

status object
tokenState string
Possible values: [NotSet, NotRegistered, NotApproved, Approved]
Default value: NotSet
ipAddress string
lastCheckedIn date-time
fingerprint string

Example (from schema)

{
  "apiVersion": "infra.k8smgmt.io/v3",
  "kind": "BootstrapAgent",
  "metadata": {
    "name": "some-name",
    "project": "defaultproject"
  },
  "spec": {
    "token": "string",
    "templateRef": "string",
    "agentMode": "InCluster"
  },
  "status": {
    "tokenState": "NotSet",
    "ipAddress": "string",
    "lastCheckedIn": "2024-02-15T00:40:10.375Z",
    "fingerprint": "string"
  }
}

403

Returned when the user does not have permission to access the resource.

application/json

Schema

Schema

any

application/yaml

Schema

Schema

any

404

Returned when the resource does not exist.

application/json

Schema

Schema

any

application/yaml

Schema

Schema

any

500

Returned for internal server error

application/json

Schema

Schema

any

application/yaml

Schema

Schema

any

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/yaml

Schema

Schema

code int32
message string
details object[]
Array [
@type string
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Authorization: X-API-KEYID

name: X-API-KEYIDtype: apiKeyin: header

name: X-API-TOKENtype: apiKeyin: header

name: BasicAuthtype: httpscheme: basic

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'https://website-qwrdwgng9-paralus.vercel.app' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-API-KEYID: <API_KEY_VALUE>' \
-H 'X-API-TOKEN: <API_KEY_VALUE>'

Request Collapse all

Auth

ApiKeyAuth

ApiTokenAuth

Username

Password

Parameters

spec.templateRef — pathrequired

Body required

Content-Type

application/jsonapplication/yaml

{
  "metadata": {
    "name": "some-name",
    "project": "defaultproject"
  },
  "spec": {
    "token": "string",
    "agentMode": "InCluster"
  },
  "status": {
    "tokenState": "NotSet",
    "ipAddress": "string",
    "lastCheckedIn": "2024-02-15T00:40:10.365Z",
    "fingerprint": "string"
  }
}