Account Rancher Infrastructure [Beta]

This contains APIs for Rancher infra entities for account level.

List rancher clusters using account level connector

List rancher clusters using the given account level rancher connector

Securityx-api-key
Request
path Parameters
connector
required
string

Identifier field of the scoped connector entity to be used for this operation.

query Parameters
page
integer
Default: 0

Pagination page number strategy: Specify the page number within the paginated collection related to the number of items in each page

limit
integer <= 1000
Default: 20

Number of items to return per page.

sort
string

Parameter on the basis of which sorting is done.

Enum: "name" "identifier" "created" "updated"
order
string

Order on the basis of which sorting is done.

Enum: "ASC" "DESC"
header Parameters
Harness-Account
string

Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.

Responses
200

Response containing list of rancher cluster names

get/v1/rancher/connectors/{connector}/clusters
Request samples
Response samples
application/json
[
  • "cluster1",
  • "cluster2"
]

List rancher clusters using account level env and infra def

List rancher clusters using the given account level environment and infrastructure definition.

Securityx-api-key
Request
path Parameters
environment
required
string

Identifier field of the scoped environment entity to be used for the selected operation.

infrastructure-definition
required
string

Identifier field of the scoped infrastructure definition entity to be used in the selected operation.

query Parameters
page
integer
Default: 0

Pagination page number strategy: Specify the page number within the paginated collection related to the number of items in each page

limit
integer <= 1000
Default: 20

Number of items to return per page.

sort
string

Parameter on the basis of which sorting is done.

Enum: "name" "identifier" "created" "updated"
order
string

Order on the basis of which sorting is done.

Enum: "ASC" "DESC"
header Parameters
Harness-Account
string

Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.

Responses
200

Response containing list of rancher cluster names

get/v1/rancher/environments/{environment}/infrastructure-definitions/{infrastructure-definition}/clusters
Request samples
Response samples
application/json
[
  • "cluster1",
  • "cluster2"
]