BootstrapService_GetBootstrapAgentTemplate

GET 
/v2/sentry/bootstrap/template/{metadata.name}

BootstrapService_GetBootstrapAgentTemplate

Request

Path Parameters

metadata.name stringrequired

name of the resource

Query Parameters

apiVersion string

Default value: infra.k8smgmt.io/v3

API Version

API Version of the resource

kind string

Default value: BootstrapAgentTemplate

Kind

Kind of the resource

metadata.displayName string

Display Name

display name of the resource

metadata.description string

Description

description of the resource

metadata.labels string

Labels

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

metadata.annotations string

Annotations

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

metadata.project stringrequired

Project

Project of the resource

metadata.organization string

Organization

Organization to which the resource belongs

metadata.partner string

Partner

Partner to which the resource belongs

metadata.id string
metadata.urlScope string
metadata.createdAt date-time
metadata.modifiedAt date-time
spec.infraRef string
spec.autoRegister boolean
spec.ignoreMultipleRegister boolean
spec.autoApprove boolean
spec.templateType string

Possible values: [TemplateTypeNotSet, Client, Server, Mixed]

Default value: TemplateTypeNotSet

spec.token string
spec.inClusterTemplate string
spec.outOfClusterTemplate 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: BootstrapAgentTemplate

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
infraRef string
autoRegister boolean
ignoreMultipleRegister boolean
autoApprove boolean
templateType string
Possible values: [TemplateTypeNotSet, Client, Server, Mixed]
Default value: TemplateTypeNotSet
token string
hosts object[]
Array [
host string
type string
Possible values: [HostTypeNotSet, HostTypeInternal, HostTypeExternal]
Default value: HostTypeNotSet
]
inClusterTemplate string
outOfClusterTemplate string
status object

Example (from schema)

{
  "apiVersion": "infra.k8smgmt.io/v3",
  "kind": "BootstrapAgentTemplate",
  "metadata": {
    "name": "some-name",
    "project": "defaultproject"
  },
  "spec": {
    "infraRef": "string",
    "autoRegister": true,
    "ignoreMultipleRegister": true,
    "autoApprove": true,
    "templateType": "TemplateTypeNotSet",
    "token": "string",
    "hosts": [
      {
        "host": "string",
        "type": "HostTypeNotSet"
      }
    ],
    "inClusterTemplate": "string",
    "outOfClusterTemplate": "string"
  },
  "status": {}
}

application/yaml

Schema

Schema

apiVersion API Version

Default value: infra.k8smgmt.io/v3

API Version of the resource

kind Kind

Default value: BootstrapAgentTemplate

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
infraRef string
autoRegister boolean
ignoreMultipleRegister boolean
autoApprove boolean
templateType string
Possible values: [TemplateTypeNotSet, Client, Server, Mixed]
Default value: TemplateTypeNotSet
token string
hosts object[]
Array [
host string
type string
Possible values: [HostTypeNotSet, HostTypeInternal, HostTypeExternal]
Default value: HostTypeNotSet
]
inClusterTemplate string
outOfClusterTemplate string
status object

Example (from schema)

{
  "apiVersion": "infra.k8smgmt.io/v3",
  "kind": "BootstrapAgentTemplate",
  "metadata": {
    "name": "some-name",
    "project": "defaultproject"
  },
  "spec": {
    "infraRef": "string",
    "autoRegister": true,
    "ignoreMultipleRegister": true,
    "autoApprove": true,
    "templateType": "TemplateTypeNotSet",
    "token": "string",
    "hosts": [
      {
        "host": "string",
        "type": "HostTypeNotSet"
      }
    ],
    "inClusterTemplate": "string",
    "outOfClusterTemplate": "string"
  },
  "status": {}
}

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...