BootstrapService_GetBootstrapAgents

GET 
/v2/sentry/bootstrap/:templateScope/agent

BootstrapService_GetBootstrapAgents

Request

Path Parameters

templateScope stringrequired

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

Query Parameters

opts.q string

query for filtering

opts.name string

name is unique ID of a resource along with (partnerID, organizationID, projectID)

opts.selector string

selector is used to filter the labels of a resource

opts.partner string
opts.organization string
opts.project string
opts.group string
opts.role string
opts.displayName string

displayName only used for update queries to set displayName (READONLY)

opts.labels string

labels only used for update queries to set labels (READONLY)

This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18

opts.annotations string

annotations only used for update queries to set annotations (READONLY)

This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18

opts.count int64
opts.offset int64
opts.limit int64
opts.ignoreScopeDefault boolean

ignoreScopeDefault ignores default values for partnerID, organizationID and projectID

opts.globalScope boolean

globalScope sets partnerID,organizationID,projectID = 0

opts.orderBy string
opts.order string
opts.deleted boolean
opts.extended boolean
opts.urlScope string

urlScope is supposed to be passed in the URL as kind/HashID(value)

opts.isSSOUser boolean
opts.username string
opts.groups string[]
opts.blueprintRef string
opts.publishedVersion string
opts.clusterID string
opts.ID string
opts.account string
opts.type string

generic way to specify a type of resource, mainly for use in users endpoint

Responses

200

A successful response.

application/json

Schema

Schema

apiVersion API Version

Default value: infra.k8smgmt.io/v3

API Version of the list resource

kind Kind

Default value: BootstrapAgentList

Kind of the list resource

metadata object
Metadata of the list resource
count int64
offset int64
limit int64
items object[]
Array [
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": "BootstrapAgentList",
  "metadata": {
    "count": "string",
    "offset": "string",
    "limit": "string"
  },
  "items": [
    {
      "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.380Z",
        "fingerprint": "string"
      }
    }
  ]
}

application/yaml

Schema

Schema

apiVersion API Version

Default value: infra.k8smgmt.io/v3

API Version of the list resource

kind Kind

Default value: BootstrapAgentList

Kind of the list resource

metadata object
Metadata of the list resource
count int64
offset int64
limit int64
items object[]
Array [
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": "BootstrapAgentList",
  "metadata": {
    "count": "string",
    "offset": "string",
    "limit": "string"
  },
  "items": [
    {
      "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.381Z",
        "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"
    }
  ]
}

Loading...