Configuration Variable Sets
Configuration Variable Sets Service handles CRUD for variable sets used by configuration products (Ansible playbooks and inventories). Independent of workspace/infrastructure variable sets.
Create a new Configuration Variable Set on account level.
Account is the internal customer account ID.
pDescription provides long-form text about the resource.
this is a more detailed explanation of the resource.Identifier is the Configuration Variable Set identifier.
86Pattern: ^[^/?#\s]+$Name is the human readable name for the resource.
resource nameConfiguration product this set belongs to.
ansibleExample: ansiblePossible values: Created response.
Create-Configuration-Variable-Set-Account-LevelResponseBody result type (default view)
Account is the internal customer account ID.
gTimestamp when the configuration variable set was created.
1627590400Description provides long-form text about the resource.
this is a more detailed explanation of the resource.Identifier is the Configuration Variable Set identifier.
ghName is the human readable name for the resource.
resource nameOrg is the organisation identifier.
rboProject is the project identifier.
o9pConfiguration product this set belongs to.
ansibleExample: ansiblePossible values: Timestamp when the configuration variable set was last updated.
1627686800BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
POST /api/configuration-variable-set HTTP/1.1
Host: localhost:80
Harness-Account: p
Content-Type: application/json
Accept: */*
Content-Length: 640
{
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {
"Modi quia qui quibusdam.": {
"created": 1627590400,
"key": "r8k",
"updated": 1627686800,
"value": "Magnam eaque dolores deleniti in.",
"value_type": "string"
},
"Qui molestiae officiis.": {
"created": 1627590400,
"key": "r8k",
"updated": 1627686800,
"value": "Magnam eaque dolores deleniti in.",
"value_type": "string"
}
},
"identifier": "z",
"name": "resource name",
"type": "ansible",
"variables": {
"Sed nihil explicabo quae eveniet perspiciatis quia.": {
"created": 1627590400,
"key": "r8k",
"updated": 1627686800,
"value": "Magnam eaque dolores deleniti in.",
"value_type": "string"
}
}
}{
"account": "a",
"created": 1627590400,
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {
"Maiores quam.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
}
},
"identifier": "k4",
"name": "resource name",
"org": "2w",
"project": "k",
"type": "ansible",
"updated": 1627686800,
"variables": {
"Alias reprehenderit consequatur quidem aut aliquid expedita.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
},
"Recusandae necessitatibus.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
},
"Sit dolorem commodi nisi totam atque hic.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
}
}
}Delete Configuration Variable Set on account level using identifier as a query parameter. Required when the identifier contains characters that are unsafe in URL paths (e.g. '/').
Identifier is the Configuration Variable Set identifier.
8Account is the internal customer account ID.
5hNo Content response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
DELETE /api/configuration-variable-set?identifier=8 HTTP/1.1
Host: localhost:80
Harness-Account: 5h
Accept: */*
No content
Get the Configuration Variable Sets attached to a playbook or inventory on account level, in priority order.
Kind of entity the Configuration Variable Sets are attached to.
inventoryPossible values: Identifier of the playbook or inventory the Configuration Variable Sets are attached to.
63xPattern: ^[^/?#\s]+$Account is the internal customer account ID.
yjhOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/configuration-variable-set-attachments/{entity_type}/{entity} HTTP/1.1
Host: localhost:80
Harness-Account: yjh
Accept: */*
{
"items": [
{
"account": "Omnis nulla eum autem et.",
"identifier": "Voluptatem neque aut.",
"name": "Odit repellat commodi quia.",
"org": "Saepe omnis aut.",
"priority": 3216599901881792500,
"project": "Et distinctio porro architecto.",
"variable_set": "account.shared_vars"
},
{
"account": "Omnis nulla eum autem et.",
"identifier": "Voluptatem neque aut.",
"name": "Odit repellat commodi quia.",
"org": "Saepe omnis aut.",
"priority": 3216599901881792500,
"project": "Et distinctio porro architecto.",
"variable_set": "account.shared_vars"
},
{
"account": "Omnis nulla eum autem et.",
"identifier": "Voluptatem neque aut.",
"name": "Odit repellat commodi quia.",
"org": "Saepe omnis aut.",
"priority": 3216599901881792500,
"project": "Et distinctio porro architecto.",
"variable_set": "account.shared_vars"
},
{
"account": "Omnis nulla eum autem et.",
"identifier": "Voluptatem neque aut.",
"name": "Odit repellat commodi quia.",
"org": "Saepe omnis aut.",
"priority": 3216599901881792500,
"project": "Et distinctio porro architecto.",
"variable_set": "account.shared_vars"
}
]
}Replace the Configuration Variable Sets attached to a playbook or inventory on account level. Array order is the priority order.
Kind of entity the Configuration Variable Sets are attached to.
playbookPossible values: Identifier of the playbook or inventory the Configuration Variable Sets are attached to.
ziPattern: ^[^/?#\s]+$Account is the internal customer account ID.
032Configuration Variable Sets to attach, in priority order. Replaces whatever is currently attached.
["account.shared_vars","org.team_vars","playbook_vars"]OK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
PUT /api/configuration-variable-set-attachments/{entity_type}/{entity} HTTP/1.1
Host: localhost:80
Harness-Account: 032
Content-Type: application/json
Accept: */*
Content-Length: 73
{
"variable_sets": [
"account.shared_vars",
"org.team_vars",
"playbook_vars"
]
}{
"items": [
{
"account": "Omnis nulla eum autem et.",
"identifier": "Voluptatem neque aut.",
"name": "Odit repellat commodi quia.",
"org": "Saepe omnis aut.",
"priority": 3216599901881792500,
"project": "Et distinctio porro architecto.",
"variable_set": "account.shared_vars"
},
{
"account": "Omnis nulla eum autem et.",
"identifier": "Voluptatem neque aut.",
"name": "Odit repellat commodi quia.",
"org": "Saepe omnis aut.",
"priority": 3216599901881792500,
"project": "Et distinctio porro architecto.",
"variable_set": "account.shared_vars"
},
{
"account": "Omnis nulla eum autem et.",
"identifier": "Voluptatem neque aut.",
"name": "Odit repellat commodi quia.",
"org": "Saepe omnis aut.",
"priority": 3216599901881792500,
"project": "Et distinctio porro architecto.",
"variable_set": "account.shared_vars"
},
{
"account": "Omnis nulla eum autem et.",
"identifier": "Voluptatem neque aut.",
"name": "Odit repellat commodi quia.",
"org": "Saepe omnis aut.",
"priority": 3216599901881792500,
"project": "Et distinctio porro architecto.",
"variable_set": "account.shared_vars"
}
]
}Remove every Configuration Variable Set attachment from a deleted account level playbook or inventory.
Kind of entity the Configuration Variable Sets are attached to.
inventoryPossible values: Identifier of the playbook or inventory the Configuration Variable Sets are attached to.
t3Pattern: ^[^/?#\s]+$Account is the internal customer account ID.
3azNo Content response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
DELETE /api/configuration-variable-set-attachments/{entity_type}/{entity} HTTP/1.1
Host: localhost:80
Harness-Account: 3az
Accept: */*
No content
Get the variables of every Configuration Variable Set attached to a playbook or inventory on account level, marking which entry wins each key.
Kind of entity the Configuration Variable Sets are attached to.
playbookPossible values: Identifier of the playbook or inventory the Configuration Variable Sets are attached to.
l9zPattern: ^[^/?#\s]+$Account is the internal customer account ID.
bwOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/configuration-variable-set-attachments/{entity_type}/{entity}/merged HTTP/1.1
Host: localhost:80
Harness-Account: bw
Accept: */*
{
"environment_variables": [
{
"associatedVariableSet": "account.shared_vars",
"inUse": true,
"key": "Sed corporis ipsa et quas.",
"priority": 2315973877903276500,
"value": "Soluta vero quod labore autem.",
"value_type": "Illum ut."
},
{
"associatedVariableSet": "account.shared_vars",
"inUse": true,
"key": "Sed corporis ipsa et quas.",
"priority": 2315973877903276500,
"value": "Soluta vero quod labore autem.",
"value_type": "Illum ut."
},
{
"associatedVariableSet": "account.shared_vars",
"inUse": true,
"key": "Sed corporis ipsa et quas.",
"priority": 2315973877903276500,
"value": "Soluta vero quod labore autem.",
"value_type": "Illum ut."
},
{
"associatedVariableSet": "account.shared_vars",
"inUse": true,
"key": "Sed corporis ipsa et quas.",
"priority": 2315973877903276500,
"value": "Soluta vero quod labore autem.",
"value_type": "Illum ut."
}
],
"variables": [
{
"associatedVariableSet": "account.shared_vars",
"inUse": true,
"key": "Sed corporis ipsa et quas.",
"priority": 2315973877903276500,
"value": "Soluta vero quod labore autem.",
"value_type": "Illum ut."
},
{
"associatedVariableSet": "account.shared_vars",
"inUse": true,
"key": "Sed corporis ipsa et quas.",
"priority": 2315973877903276500,
"value": "Soluta vero quod labore autem.",
"value_type": "Illum ut."
},
{
"associatedVariableSet": "account.shared_vars",
"inUse": true,
"key": "Sed corporis ipsa et quas.",
"priority": 2315973877903276500,
"value": "Soluta vero quod labore autem.",
"value_type": "Illum ut."
}
]
}Get Configuration Variable Set by identifier on account level.
Identifier is the Configuration Variable Set identifier.
pAccount is the internal customer account ID.
0ylOK response.
Get-Configuration-Variable-Set-Account-LevelResponseBody result type (default view)
Account is the internal customer account ID.
tTimestamp when the configuration variable set was created.
1627590400Description provides long-form text about the resource.
this is a more detailed explanation of the resource.Identifier is the Configuration Variable Set identifier.
nName is the human readable name for the resource.
resource nameOrg is the organisation identifier.
26Project is the project identifier.
jxConfiguration product this set belongs to.
ansibleExample: ansiblePossible values: Timestamp when the configuration variable set was last updated.
1627686800BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/configuration-variable-set/{identifier} HTTP/1.1
Host: localhost:80
Harness-Account: 0yl
Accept: */*
{
"account": "zjz",
"created": 1627590400,
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {
"Qui optio sint aut eum enim sit.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
},
"Temporibus autem voluptatibus eveniet.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
}
},
"identifier": "mjf",
"name": "resource name",
"org": "1t",
"project": "ret",
"type": "ansible",
"updated": 1627686800,
"variables": {
"Cupiditate ut voluptatibus.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
}
}
}Update a Configuration Variable Set on account level.
Identifier is the Configuration Variable Set identifier.
2Pattern: ^[^/?#\s]+$Account is the internal customer account ID.
jgzDescription provides long-form text about the resource.
this is a more detailed explanation of the resource.Name is the human readable name for the resource.
resource nameOK response.
Create-Configuration-Variable-Set-Account-LevelResponseBody result type (default view)
Account is the internal customer account ID.
gTimestamp when the configuration variable set was created.
1627590400Description provides long-form text about the resource.
this is a more detailed explanation of the resource.Identifier is the Configuration Variable Set identifier.
ghName is the human readable name for the resource.
resource nameOrg is the organisation identifier.
rboProject is the project identifier.
o9pConfiguration product this set belongs to.
ansibleExample: ansiblePossible values: Timestamp when the configuration variable set was last updated.
1627686800BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
PUT /api/configuration-variable-set/{identifier} HTTP/1.1
Host: localhost:80
Harness-Account: jgz
Content-Type: application/json
Accept: */*
Content-Length: 561
{
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {
"Alias voluptatem.": {
"created": 1627590400,
"key": "r8k",
"updated": 1627686800,
"value": "Magnam eaque dolores deleniti in.",
"value_type": "string"
}
},
"name": "resource name",
"variables": {
"Et explicabo.": {
"created": 1627590400,
"key": "r8k",
"updated": 1627686800,
"value": "Magnam eaque dolores deleniti in.",
"value_type": "string"
},
"Harum mollitia sint et.": {
"created": 1627590400,
"key": "r8k",
"updated": 1627686800,
"value": "Magnam eaque dolores deleniti in.",
"value_type": "string"
}
}
}{
"account": "a",
"created": 1627590400,
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {
"Maiores quam.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
}
},
"identifier": "k4",
"name": "resource name",
"org": "2w",
"project": "k",
"type": "ansible",
"updated": 1627686800,
"variables": {
"Alias reprehenderit consequatur quidem aut aliquid expedita.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
},
"Recusandae necessitatibus.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
},
"Sit dolorem commodi nisi totam atque hic.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
}
}
}Delete Configuration Variable Set by identifier on account level.
Identifier is the Configuration Variable Set identifier.
spAccount is the internal customer account ID.
fqNo Content response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
DELETE /api/configuration-variable-set/{identifier} HTTP/1.1
Host: localhost:80
Harness-Account: fq
Accept: */*
No content
List the playbooks and inventories a Configuration Variable Set on account level is attached to.
Identifier is the Configuration Variable Set identifier.
ejAccount is the internal customer account ID.
o9OK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/configuration-variable-set/{identifier}/references HTTP/1.1
Host: localhost:80
Harness-Account: o9
Accept: */*
{
"items": [
{
"account": "Molestiae dolor sed doloribus facere voluptas.",
"entity_type": "inventory",
"identifier": "Et accusamus eos modi recusandae consectetur repudiandae.",
"name": "Aut velit ea laudantium nesciunt.",
"org": "Voluptatem aut officia.",
"priority": 1037321779404229900,
"project": "Velit voluptatem soluta quaerat."
},
{
"account": "Molestiae dolor sed doloribus facere voluptas.",
"entity_type": "inventory",
"identifier": "Et accusamus eos modi recusandae consectetur repudiandae.",
"name": "Aut velit ea laudantium nesciunt.",
"org": "Voluptatem aut officia.",
"priority": 1037321779404229900,
"project": "Velit voluptatem soluta quaerat."
},
{
"account": "Molestiae dolor sed doloribus facere voluptas.",
"entity_type": "inventory",
"identifier": "Et accusamus eos modi recusandae consectetur repudiandae.",
"name": "Aut velit ea laudantium nesciunt.",
"org": "Voluptatem aut officia.",
"priority": 1037321779404229900,
"project": "Velit voluptatem soluta quaerat."
}
]
}Get Configuration Variable Set list on account level.
Optional configuration product type to filter the list.
ansiblePossible values: Account is the internal customer account ID.
rveOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/configuration-variable-sets HTTP/1.1
Host: localhost:80
Harness-Account: rve
Accept: */*
{
"items": [
{
"account": "w",
"created": 1627590400,
"description": "this is a more detailed explanation of the resource.",
"env_vars_count": 6097743661779087000,
"environment_variables": {
"Aperiam sapiente hic.": {
"created": 1627590400,
"key": "x",
"updated": 1627686800,
"value": "Tempore unde.",
"value_type": "json"
},
"Ea repudiandae iusto non.": {
"created": 1627590400,
"key": "x",
"updated": 1627686800,
"value": "Tempore unde.",
"value_type": "json"
},
"Et velit odio.": {
"created": 1627590400,
"key": "x",
"updated": 1627686800,
"value": "Tempore unde.",
"value_type": "json"
}
},
"identifier": "k8",
"name": "resource name",
"org": "ij",
"project": "gwc",
"type": "ansible",
"updated": 1627686800,
"variables": {
"Officia molestiae adipisci.": {
"created": 1627590400,
"key": "x",
"updated": 1627686800,
"value": "Tempore unde.",
"value_type": "json"
}
},
"vars_count": 175867220696504640
},
{
"account": "w",
"created": 1627590400,
"description": "this is a more detailed explanation of the resource.",
"env_vars_count": 6097743661779087000,
"environment_variables": {
"Aperiam sapiente hic.": {
"created": 1627590400,
"key": "x",
"updated": 1627686800,
"value": "Tempore unde.",
"value_type": "json"
},
"Ea repudiandae iusto non.": {
"created": 1627590400,
"key": "x",
"updated": 1627686800,
"value": "Tempore unde.",
"value_type": "json"
},
"Et velit odio.": {
"created": 1627590400,
"key": "x",
"updated": 1627686800,
"value": "Tempore unde.",
"value_type": "json"
}
},
"identifier": "k8",
"name": "resource name",
"org": "ij",
"project": "gwc",
"type": "ansible",
"updated": 1627686800,
"variables": {
"Officia molestiae adipisci.": {
"created": 1627590400,
"key": "x",
"updated": 1627686800,
"value": "Tempore unde.",
"value_type": "json"
}
},
"vars_count": 175867220696504640
}
]
}Create a new Configuration Variable Set on org level.
Org is the organisation identifier.
nAccount is the internal customer account ID.
fDescription provides long-form text about the resource.
this is a more detailed explanation of the resource.Identifier is the Configuration Variable Set identifier.
nkPattern: ^[^/?#\s]+$Name is the human readable name for the resource.
resource nameConfiguration product this set belongs to.
ansibleExample: ansiblePossible values: Created response.
Create-Configuration-Variable-Set-Account-LevelResponseBody result type (default view)
Account is the internal customer account ID.
gTimestamp when the configuration variable set was created.
1627590400Description provides long-form text about the resource.
this is a more detailed explanation of the resource.Identifier is the Configuration Variable Set identifier.
ghName is the human readable name for the resource.
resource nameOrg is the organisation identifier.
rboProject is the project identifier.
o9pConfiguration product this set belongs to.
ansibleExample: ansiblePossible values: Timestamp when the configuration variable set was last updated.
1627686800BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
POST /api/orgs/{org}/configuration-variable-set HTTP/1.1
Host: localhost:80
Harness-Account: f
Content-Type: application/json
Accept: */*
Content-Length: 807
{
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {
"Non atque non et quia velit.": {
"created": 1627590400,
"key": "r8k",
"updated": 1627686800,
"value": "Magnam eaque dolores deleniti in.",
"value_type": "string"
},
"Officiis quis voluptatibus minus molestiae enim.": {
"created": 1627590400,
"key": "r8k",
"updated": 1627686800,
"value": "Magnam eaque dolores deleniti in.",
"value_type": "string"
}
},
"identifier": "nm0",
"name": "resource name",
"type": "ansible",
"variables": {
"Et est corrupti suscipit.": {
"created": 1627590400,
"key": "r8k",
"updated": 1627686800,
"value": "Magnam eaque dolores deleniti in.",
"value_type": "string"
},
"Inventore aut est est rerum ut illum.": {
"created": 1627590400,
"key": "r8k",
"updated": 1627686800,
"value": "Magnam eaque dolores deleniti in.",
"value_type": "string"
}
}
}{
"account": "a",
"created": 1627590400,
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {
"Maiores quam.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
}
},
"identifier": "k4",
"name": "resource name",
"org": "2w",
"project": "k",
"type": "ansible",
"updated": 1627686800,
"variables": {
"Alias reprehenderit consequatur quidem aut aliquid expedita.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
},
"Recusandae necessitatibus.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
},
"Sit dolorem commodi nisi totam atque hic.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
}
}
}Delete Configuration Variable Set on org level using identifier as a query parameter. Required when the identifier contains characters that are unsafe in URL paths (e.g. '/').
Org is the organisation identifier.
98iIdentifier is the Configuration Variable Set identifier.
uAccount is the internal customer account ID.
m2No Content response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
DELETE /api/orgs/{org}/configuration-variable-set?identifier=u HTTP/1.1
Host: localhost:80
Harness-Account: m2
Accept: */*
No content
Get the Configuration Variable Sets attached to a playbook or inventory on org level, in priority order.
Org is the organisation identifier.
u8Kind of entity the Configuration Variable Sets are attached to.
inventoryPossible values: Identifier of the playbook or inventory the Configuration Variable Sets are attached to.
brmPattern: ^[^/?#\s]+$Account is the internal customer account ID.
emxOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/configuration-variable-set-attachments/{entity_type}/{entity} HTTP/1.1
Host: localhost:80
Harness-Account: emx
Accept: */*
{
"items": [
{
"account": "Omnis nulla eum autem et.",
"identifier": "Voluptatem neque aut.",
"name": "Odit repellat commodi quia.",
"org": "Saepe omnis aut.",
"priority": 3216599901881792500,
"project": "Et distinctio porro architecto.",
"variable_set": "account.shared_vars"
},
{
"account": "Omnis nulla eum autem et.",
"identifier": "Voluptatem neque aut.",
"name": "Odit repellat commodi quia.",
"org": "Saepe omnis aut.",
"priority": 3216599901881792500,
"project": "Et distinctio porro architecto.",
"variable_set": "account.shared_vars"
},
{
"account": "Omnis nulla eum autem et.",
"identifier": "Voluptatem neque aut.",
"name": "Odit repellat commodi quia.",
"org": "Saepe omnis aut.",
"priority": 3216599901881792500,
"project": "Et distinctio porro architecto.",
"variable_set": "account.shared_vars"
},
{
"account": "Omnis nulla eum autem et.",
"identifier": "Voluptatem neque aut.",
"name": "Odit repellat commodi quia.",
"org": "Saepe omnis aut.",
"priority": 3216599901881792500,
"project": "Et distinctio porro architecto.",
"variable_set": "account.shared_vars"
}
]
}Replace the Configuration Variable Sets attached to a playbook or inventory on org level. Array order is the priority order.
Org is the organisation identifier.
a73Kind of entity the Configuration Variable Sets are attached to.
inventoryPossible values: Identifier of the playbook or inventory the Configuration Variable Sets are attached to.
zwPattern: ^[^/?#\s]+$Account is the internal customer account ID.
gvConfiguration Variable Sets to attach, in priority order. Replaces whatever is currently attached.
["account.shared_vars","org.team_vars","playbook_vars"]OK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
PUT /api/orgs/{org}/configuration-variable-set-attachments/{entity_type}/{entity} HTTP/1.1
Host: localhost:80
Harness-Account: gv
Content-Type: application/json
Accept: */*
Content-Length: 73
{
"variable_sets": [
"account.shared_vars",
"org.team_vars",
"playbook_vars"
]
}{
"items": [
{
"account": "Omnis nulla eum autem et.",
"identifier": "Voluptatem neque aut.",
"name": "Odit repellat commodi quia.",
"org": "Saepe omnis aut.",
"priority": 3216599901881792500,
"project": "Et distinctio porro architecto.",
"variable_set": "account.shared_vars"
},
{
"account": "Omnis nulla eum autem et.",
"identifier": "Voluptatem neque aut.",
"name": "Odit repellat commodi quia.",
"org": "Saepe omnis aut.",
"priority": 3216599901881792500,
"project": "Et distinctio porro architecto.",
"variable_set": "account.shared_vars"
},
{
"account": "Omnis nulla eum autem et.",
"identifier": "Voluptatem neque aut.",
"name": "Odit repellat commodi quia.",
"org": "Saepe omnis aut.",
"priority": 3216599901881792500,
"project": "Et distinctio porro architecto.",
"variable_set": "account.shared_vars"
},
{
"account": "Omnis nulla eum autem et.",
"identifier": "Voluptatem neque aut.",
"name": "Odit repellat commodi quia.",
"org": "Saepe omnis aut.",
"priority": 3216599901881792500,
"project": "Et distinctio porro architecto.",
"variable_set": "account.shared_vars"
}
]
}Remove every Configuration Variable Set attachment from a deleted org level playbook or inventory.
Org is the organisation identifier.
lo6Kind of entity the Configuration Variable Sets are attached to.
playbookPossible values: Identifier of the playbook or inventory the Configuration Variable Sets are attached to.
j6uPattern: ^[^/?#\s]+$Account is the internal customer account ID.
nk0No Content response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
DELETE /api/orgs/{org}/configuration-variable-set-attachments/{entity_type}/{entity} HTTP/1.1
Host: localhost:80
Harness-Account: nk0
Accept: */*
No content
Get the variables of every Configuration Variable Set attached to a playbook or inventory on org level, marking which entry wins each key.
Org is the organisation identifier.
knmKind of entity the Configuration Variable Sets are attached to.
inventoryPossible values: Identifier of the playbook or inventory the Configuration Variable Sets are attached to.
3Pattern: ^[^/?#\s]+$Account is the internal customer account ID.
qqOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/configuration-variable-set-attachments/{entity_type}/{entity}/merged HTTP/1.1
Host: localhost:80
Harness-Account: qq
Accept: */*
{
"environment_variables": [
{
"associatedVariableSet": "account.shared_vars",
"inUse": true,
"key": "Sed corporis ipsa et quas.",
"priority": 2315973877903276500,
"value": "Soluta vero quod labore autem.",
"value_type": "Illum ut."
},
{
"associatedVariableSet": "account.shared_vars",
"inUse": true,
"key": "Sed corporis ipsa et quas.",
"priority": 2315973877903276500,
"value": "Soluta vero quod labore autem.",
"value_type": "Illum ut."
},
{
"associatedVariableSet": "account.shared_vars",
"inUse": true,
"key": "Sed corporis ipsa et quas.",
"priority": 2315973877903276500,
"value": "Soluta vero quod labore autem.",
"value_type": "Illum ut."
},
{
"associatedVariableSet": "account.shared_vars",
"inUse": true,
"key": "Sed corporis ipsa et quas.",
"priority": 2315973877903276500,
"value": "Soluta vero quod labore autem.",
"value_type": "Illum ut."
}
],
"variables": [
{
"associatedVariableSet": "account.shared_vars",
"inUse": true,
"key": "Sed corporis ipsa et quas.",
"priority": 2315973877903276500,
"value": "Soluta vero quod labore autem.",
"value_type": "Illum ut."
},
{
"associatedVariableSet": "account.shared_vars",
"inUse": true,
"key": "Sed corporis ipsa et quas.",
"priority": 2315973877903276500,
"value": "Soluta vero quod labore autem.",
"value_type": "Illum ut."
},
{
"associatedVariableSet": "account.shared_vars",
"inUse": true,
"key": "Sed corporis ipsa et quas.",
"priority": 2315973877903276500,
"value": "Soluta vero quod labore autem.",
"value_type": "Illum ut."
}
]
}Get Configuration Variable Set by identifier on org level.
Org is the organisation identifier.
7Identifier is the Configuration Variable Set identifier.
7Account is the internal customer account ID.
8ahOK response.
Get-Configuration-Variable-Set-Account-LevelResponseBody result type (default view)
Account is the internal customer account ID.
tTimestamp when the configuration variable set was created.
1627590400Description provides long-form text about the resource.
this is a more detailed explanation of the resource.Identifier is the Configuration Variable Set identifier.
nName is the human readable name for the resource.
resource nameOrg is the organisation identifier.
26Project is the project identifier.
jxConfiguration product this set belongs to.
ansibleExample: ansiblePossible values: Timestamp when the configuration variable set was last updated.
1627686800BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/configuration-variable-set/{identifier} HTTP/1.1
Host: localhost:80
Harness-Account: 8ah
Accept: */*
{
"account": "zjz",
"created": 1627590400,
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {
"Qui optio sint aut eum enim sit.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
},
"Temporibus autem voluptatibus eveniet.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
}
},
"identifier": "mjf",
"name": "resource name",
"org": "1t",
"project": "ret",
"type": "ansible",
"updated": 1627686800,
"variables": {
"Cupiditate ut voluptatibus.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
}
}
}Update a Configuration Variable Set on org level.
Org is the organisation identifier.
vqIdentifier is the Configuration Variable Set identifier.
8bvPattern: ^[^/?#\s]+$Account is the internal customer account ID.
ackDescription provides long-form text about the resource.
this is a more detailed explanation of the resource.Name is the human readable name for the resource.
resource nameOK response.
Create-Configuration-Variable-Set-Account-LevelResponseBody result type (default view)
Account is the internal customer account ID.
gTimestamp when the configuration variable set was created.
1627590400Description provides long-form text about the resource.
this is a more detailed explanation of the resource.Identifier is the Configuration Variable Set identifier.
ghName is the human readable name for the resource.
resource nameOrg is the organisation identifier.
rboProject is the project identifier.
o9pConfiguration product this set belongs to.
ansibleExample: ansiblePossible values: Timestamp when the configuration variable set was last updated.
1627686800BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
PUT /api/orgs/{org}/configuration-variable-set/{identifier} HTTP/1.1
Host: localhost:80
Harness-Account: ack
Content-Type: application/json
Accept: */*
Content-Length: 1037
{
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {
"Consequatur aut commodi.": {
"created": 1627590400,
"key": "r8k",
"updated": 1627686800,
"value": "Magnam eaque dolores deleniti in.",
"value_type": "string"
},
"Fugit autem ut in omnis quo.": {
"created": 1627590400,
"key": "r8k",
"updated": 1627686800,
"value": "Magnam eaque dolores deleniti in.",
"value_type": "string"
},
"Officia nesciunt.": {
"created": 1627590400,
"key": "r8k",
"updated": 1627686800,
"value": "Magnam eaque dolores deleniti in.",
"value_type": "string"
}
},
"name": "resource name",
"variables": {
"Cupiditate eum fugiat culpa autem.": {
"created": 1627590400,
"key": "r8k",
"updated": 1627686800,
"value": "Magnam eaque dolores deleniti in.",
"value_type": "string"
},
"Harum id quia.": {
"created": 1627590400,
"key": "r8k",
"updated": 1627686800,
"value": "Magnam eaque dolores deleniti in.",
"value_type": "string"
},
"Id numquam sit ipsa in reprehenderit.": {
"created": 1627590400,
"key": "r8k",
"updated": 1627686800,
"value": "Magnam eaque dolores deleniti in.",
"value_type": "string"
}
}
}{
"account": "a",
"created": 1627590400,
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {
"Maiores quam.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
}
},
"identifier": "k4",
"name": "resource name",
"org": "2w",
"project": "k",
"type": "ansible",
"updated": 1627686800,
"variables": {
"Alias reprehenderit consequatur quidem aut aliquid expedita.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
},
"Recusandae necessitatibus.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
},
"Sit dolorem commodi nisi totam atque hic.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
}
}
}Delete Configuration Variable Set by identifier on org level.
Org is the organisation identifier.
zIdentifier is the Configuration Variable Set identifier.
mAccount is the internal customer account ID.
3No Content response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
DELETE /api/orgs/{org}/configuration-variable-set/{identifier} HTTP/1.1
Host: localhost:80
Harness-Account: 3
Accept: */*
No content
List the playbooks and inventories a Configuration Variable Set on org level is attached to.
Org is the organisation identifier.
7Identifier is the Configuration Variable Set identifier.
ajAccount is the internal customer account ID.
pkOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/configuration-variable-set/{identifier}/references HTTP/1.1
Host: localhost:80
Harness-Account: pk
Accept: */*
{
"items": [
{
"account": "Molestiae dolor sed doloribus facere voluptas.",
"entity_type": "inventory",
"identifier": "Et accusamus eos modi recusandae consectetur repudiandae.",
"name": "Aut velit ea laudantium nesciunt.",
"org": "Voluptatem aut officia.",
"priority": 1037321779404229900,
"project": "Velit voluptatem soluta quaerat."
},
{
"account": "Molestiae dolor sed doloribus facere voluptas.",
"entity_type": "inventory",
"identifier": "Et accusamus eos modi recusandae consectetur repudiandae.",
"name": "Aut velit ea laudantium nesciunt.",
"org": "Voluptatem aut officia.",
"priority": 1037321779404229900,
"project": "Velit voluptatem soluta quaerat."
},
{
"account": "Molestiae dolor sed doloribus facere voluptas.",
"entity_type": "inventory",
"identifier": "Et accusamus eos modi recusandae consectetur repudiandae.",
"name": "Aut velit ea laudantium nesciunt.",
"org": "Voluptatem aut officia.",
"priority": 1037321779404229900,
"project": "Velit voluptatem soluta quaerat."
},
{
"account": "Molestiae dolor sed doloribus facere voluptas.",
"entity_type": "inventory",
"identifier": "Et accusamus eos modi recusandae consectetur repudiandae.",
"name": "Aut velit ea laudantium nesciunt.",
"org": "Voluptatem aut officia.",
"priority": 1037321779404229900,
"project": "Velit voluptatem soluta quaerat."
}
]
}Get Configuration Variable Set list on org level.
Org is the organisation identifier.
pOptional configuration product type to filter the list.
ansiblePossible values: Account is the internal customer account ID.
8OK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/configuration-variable-sets HTTP/1.1
Host: localhost:80
Harness-Account: 8
Accept: */*
{
"items": [
{
"account": "w",
"created": 1627590400,
"description": "this is a more detailed explanation of the resource.",
"env_vars_count": 6097743661779087000,
"environment_variables": {
"Aperiam sapiente hic.": {
"created": 1627590400,
"key": "x",
"updated": 1627686800,
"value": "Tempore unde.",
"value_type": "json"
},
"Ea repudiandae iusto non.": {
"created": 1627590400,
"key": "x",
"updated": 1627686800,
"value": "Tempore unde.",
"value_type": "json"
},
"Et velit odio.": {
"created": 1627590400,
"key": "x",
"updated": 1627686800,
"value": "Tempore unde.",
"value_type": "json"
}
},
"identifier": "k8",
"name": "resource name",
"org": "ij",
"project": "gwc",
"type": "ansible",
"updated": 1627686800,
"variables": {
"Officia molestiae adipisci.": {
"created": 1627590400,
"key": "x",
"updated": 1627686800,
"value": "Tempore unde.",
"value_type": "json"
}
},
"vars_count": 175867220696504640
},
{
"account": "w",
"created": 1627590400,
"description": "this is a more detailed explanation of the resource.",
"env_vars_count": 6097743661779087000,
"environment_variables": {
"Aperiam sapiente hic.": {
"created": 1627590400,
"key": "x",
"updated": 1627686800,
"value": "Tempore unde.",
"value_type": "json"
},
"Ea repudiandae iusto non.": {
"created": 1627590400,
"key": "x",
"updated": 1627686800,
"value": "Tempore unde.",
"value_type": "json"
},
"Et velit odio.": {
"created": 1627590400,
"key": "x",
"updated": 1627686800,
"value": "Tempore unde.",
"value_type": "json"
}
},
"identifier": "k8",
"name": "resource name",
"org": "ij",
"project": "gwc",
"type": "ansible",
"updated": 1627686800,
"variables": {
"Officia molestiae adipisci.": {
"created": 1627590400,
"key": "x",
"updated": 1627686800,
"value": "Tempore unde.",
"value_type": "json"
}
},
"vars_count": 175867220696504640
}
]
}Create a new Configuration Variable Set on project level.
Org is the organisation identifier.
qkbProject is the project identifier.
99qAccount is the internal customer account ID.
rDescription provides long-form text about the resource.
this is a more detailed explanation of the resource.Identifier is the Configuration Variable Set identifier.
nzsPattern: ^[^/?#\s]+$Name is the human readable name for the resource.
resource nameConfiguration product this set belongs to.
ansibleExample: ansiblePossible values: Created response.
Create-Configuration-Variable-Set-Account-LevelResponseBody result type (default view)
Account is the internal customer account ID.
gTimestamp when the configuration variable set was created.
1627590400Description provides long-form text about the resource.
this is a more detailed explanation of the resource.Identifier is the Configuration Variable Set identifier.
ghName is the human readable name for the resource.
resource nameOrg is the organisation identifier.
rboProject is the project identifier.
o9pConfiguration product this set belongs to.
ansibleExample: ansiblePossible values: Timestamp when the configuration variable set was last updated.
1627686800BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
POST /api/orgs/{org}/projects/{project}/configuration-variable-set HTTP/1.1
Host: localhost:80
Harness-Account: r
Content-Type: application/json
Accept: */*
Content-Length: 957
{
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {
"Magnam ab.": {
"created": 1627590400,
"key": "r8k",
"updated": 1627686800,
"value": "Magnam eaque dolores deleniti in.",
"value_type": "string"
},
"Temporibus et sint fugiat ad fugit doloremque.": {
"created": 1627590400,
"key": "r8k",
"updated": 1627686800,
"value": "Magnam eaque dolores deleniti in.",
"value_type": "string"
}
},
"identifier": "i",
"name": "resource name",
"type": "ansible",
"variables": {
"Ad nobis officia et sunt a eaque.": {
"created": 1627590400,
"key": "r8k",
"updated": 1627686800,
"value": "Magnam eaque dolores deleniti in.",
"value_type": "string"
},
"Sint quos maxime reprehenderit.": {
"created": 1627590400,
"key": "r8k",
"updated": 1627686800,
"value": "Magnam eaque dolores deleniti in.",
"value_type": "string"
},
"Voluptas incidunt aut in et nostrum corrupti.": {
"created": 1627590400,
"key": "r8k",
"updated": 1627686800,
"value": "Magnam eaque dolores deleniti in.",
"value_type": "string"
}
}
}{
"account": "a",
"created": 1627590400,
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {
"Maiores quam.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
}
},
"identifier": "k4",
"name": "resource name",
"org": "2w",
"project": "k",
"type": "ansible",
"updated": 1627686800,
"variables": {
"Alias reprehenderit consequatur quidem aut aliquid expedita.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
},
"Recusandae necessitatibus.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
},
"Sit dolorem commodi nisi totam atque hic.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
}
}
}Delete Configuration Variable Set on project level using identifier as a query parameter. Required when the identifier contains characters that are unsafe in URL paths (e.g. '/').
Org is the organisation identifier.
wProject is the project identifier.
cIdentifier is the Configuration Variable Set identifier.
boAccount is the internal customer account ID.
6No Content response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
DELETE /api/orgs/{org}/projects/{project}/configuration-variable-set?identifier=bo HTTP/1.1
Host: localhost:80
Harness-Account: 6
Accept: */*
No content
Get the Configuration Variable Sets attached to a playbook or inventory on project level, in priority order.
Org is the organisation identifier.
rProject is the project identifier.
a8pKind of entity the Configuration Variable Sets are attached to.
playbookPossible values: Identifier of the playbook or inventory the Configuration Variable Sets are attached to.
izPattern: ^[^/?#\s]+$Account is the internal customer account ID.
hOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/configuration-variable-set-attachments/{entity_type}/{entity} HTTP/1.1
Host: localhost:80
Harness-Account: h
Accept: */*
{
"items": [
{
"account": "Omnis nulla eum autem et.",
"identifier": "Voluptatem neque aut.",
"name": "Odit repellat commodi quia.",
"org": "Saepe omnis aut.",
"priority": 3216599901881792500,
"project": "Et distinctio porro architecto.",
"variable_set": "account.shared_vars"
},
{
"account": "Omnis nulla eum autem et.",
"identifier": "Voluptatem neque aut.",
"name": "Odit repellat commodi quia.",
"org": "Saepe omnis aut.",
"priority": 3216599901881792500,
"project": "Et distinctio porro architecto.",
"variable_set": "account.shared_vars"
},
{
"account": "Omnis nulla eum autem et.",
"identifier": "Voluptatem neque aut.",
"name": "Odit repellat commodi quia.",
"org": "Saepe omnis aut.",
"priority": 3216599901881792500,
"project": "Et distinctio porro architecto.",
"variable_set": "account.shared_vars"
},
{
"account": "Omnis nulla eum autem et.",
"identifier": "Voluptatem neque aut.",
"name": "Odit repellat commodi quia.",
"org": "Saepe omnis aut.",
"priority": 3216599901881792500,
"project": "Et distinctio porro architecto.",
"variable_set": "account.shared_vars"
}
]
}Replace the Configuration Variable Sets attached to a playbook or inventory on project level. Array order is the priority order.
Org is the organisation identifier.
wmProject is the project identifier.
iwKind of entity the Configuration Variable Sets are attached to.
inventoryPossible values: Identifier of the playbook or inventory the Configuration Variable Sets are attached to.
phnPattern: ^[^/?#\s]+$Account is the internal customer account ID.
2pyConfiguration Variable Sets to attach, in priority order. Replaces whatever is currently attached.
["account.shared_vars","org.team_vars","playbook_vars"]OK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
PUT /api/orgs/{org}/projects/{project}/configuration-variable-set-attachments/{entity_type}/{entity} HTTP/1.1
Host: localhost:80
Harness-Account: 2py
Content-Type: application/json
Accept: */*
Content-Length: 73
{
"variable_sets": [
"account.shared_vars",
"org.team_vars",
"playbook_vars"
]
}{
"items": [
{
"account": "Omnis nulla eum autem et.",
"identifier": "Voluptatem neque aut.",
"name": "Odit repellat commodi quia.",
"org": "Saepe omnis aut.",
"priority": 3216599901881792500,
"project": "Et distinctio porro architecto.",
"variable_set": "account.shared_vars"
},
{
"account": "Omnis nulla eum autem et.",
"identifier": "Voluptatem neque aut.",
"name": "Odit repellat commodi quia.",
"org": "Saepe omnis aut.",
"priority": 3216599901881792500,
"project": "Et distinctio porro architecto.",
"variable_set": "account.shared_vars"
},
{
"account": "Omnis nulla eum autem et.",
"identifier": "Voluptatem neque aut.",
"name": "Odit repellat commodi quia.",
"org": "Saepe omnis aut.",
"priority": 3216599901881792500,
"project": "Et distinctio porro architecto.",
"variable_set": "account.shared_vars"
},
{
"account": "Omnis nulla eum autem et.",
"identifier": "Voluptatem neque aut.",
"name": "Odit repellat commodi quia.",
"org": "Saepe omnis aut.",
"priority": 3216599901881792500,
"project": "Et distinctio porro architecto.",
"variable_set": "account.shared_vars"
}
]
}Remove every Configuration Variable Set attachment from a deleted project level playbook or inventory.
Org is the organisation identifier.
x9Project is the project identifier.
1Kind of entity the Configuration Variable Sets are attached to.
playbookPossible values: Identifier of the playbook or inventory the Configuration Variable Sets are attached to.
a4jPattern: ^[^/?#\s]+$Account is the internal customer account ID.
nNo Content response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
DELETE /api/orgs/{org}/projects/{project}/configuration-variable-set-attachments/{entity_type}/{entity} HTTP/1.1
Host: localhost:80
Harness-Account: n
Accept: */*
No content
Get the variables of every Configuration Variable Set attached to a playbook or inventory on project level, marking which entry wins each key.
Org is the organisation identifier.
pProject is the project identifier.
6ksKind of entity the Configuration Variable Sets are attached to.
playbookPossible values: Identifier of the playbook or inventory the Configuration Variable Sets are attached to.
zePattern: ^[^/?#\s]+$Account is the internal customer account ID.
dsyOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/configuration-variable-set-attachments/{entity_type}/{entity}/merged HTTP/1.1
Host: localhost:80
Harness-Account: dsy
Accept: */*
{
"environment_variables": [
{
"associatedVariableSet": "account.shared_vars",
"inUse": true,
"key": "Sed corporis ipsa et quas.",
"priority": 2315973877903276500,
"value": "Soluta vero quod labore autem.",
"value_type": "Illum ut."
},
{
"associatedVariableSet": "account.shared_vars",
"inUse": true,
"key": "Sed corporis ipsa et quas.",
"priority": 2315973877903276500,
"value": "Soluta vero quod labore autem.",
"value_type": "Illum ut."
}
],
"variables": [
{
"associatedVariableSet": "account.shared_vars",
"inUse": true,
"key": "Sed corporis ipsa et quas.",
"priority": 2315973877903276500,
"value": "Soluta vero quod labore autem.",
"value_type": "Illum ut."
},
{
"associatedVariableSet": "account.shared_vars",
"inUse": true,
"key": "Sed corporis ipsa et quas.",
"priority": 2315973877903276500,
"value": "Soluta vero quod labore autem.",
"value_type": "Illum ut."
},
{
"associatedVariableSet": "account.shared_vars",
"inUse": true,
"key": "Sed corporis ipsa et quas.",
"priority": 2315973877903276500,
"value": "Soluta vero quod labore autem.",
"value_type": "Illum ut."
}
]
}Get Configuration Variable Set by identifier on project level.
Org is the organisation identifier.
8xdProject is the project identifier.
2vIdentifier is the Configuration Variable Set identifier.
jlAccount is the internal customer account ID.
6OK response.
Get-Configuration-Variable-Set-Account-LevelResponseBody result type (default view)
Account is the internal customer account ID.
tTimestamp when the configuration variable set was created.
1627590400Description provides long-form text about the resource.
this is a more detailed explanation of the resource.Identifier is the Configuration Variable Set identifier.
nName is the human readable name for the resource.
resource nameOrg is the organisation identifier.
26Project is the project identifier.
jxConfiguration product this set belongs to.
ansibleExample: ansiblePossible values: Timestamp when the configuration variable set was last updated.
1627686800BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/configuration-variable-set/{identifier} HTTP/1.1
Host: localhost:80
Harness-Account: 6
Accept: */*
{
"account": "zjz",
"created": 1627590400,
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {
"Qui optio sint aut eum enim sit.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
},
"Temporibus autem voluptatibus eveniet.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
}
},
"identifier": "mjf",
"name": "resource name",
"org": "1t",
"project": "ret",
"type": "ansible",
"updated": 1627686800,
"variables": {
"Cupiditate ut voluptatibus.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
}
}
}Update a Configuration Variable Set on project level.
Org is the organisation identifier.
id3Project is the project identifier.
nIdentifier is the Configuration Variable Set identifier.
ekPattern: ^[^/?#\s]+$Account is the internal customer account ID.
ovbDescription provides long-form text about the resource.
this is a more detailed explanation of the resource.Name is the human readable name for the resource.
resource nameOK response.
Create-Configuration-Variable-Set-Account-LevelResponseBody result type (default view)
Account is the internal customer account ID.
gTimestamp when the configuration variable set was created.
1627590400Description provides long-form text about the resource.
this is a more detailed explanation of the resource.Identifier is the Configuration Variable Set identifier.
ghName is the human readable name for the resource.
resource nameOrg is the organisation identifier.
rboProject is the project identifier.
o9pConfiguration product this set belongs to.
ansibleExample: ansiblePossible values: Timestamp when the configuration variable set was last updated.
1627686800BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
PUT /api/orgs/{org}/projects/{project}/configuration-variable-set/{identifier} HTTP/1.1
Host: localhost:80
Harness-Account: ovb
Content-Type: application/json
Accept: */*
Content-Length: 459
{
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {
"Aspernatur voluptatem minus sed veniam et quod.": {
"created": 1627590400,
"key": "r8k",
"updated": 1627686800,
"value": "Magnam eaque dolores deleniti in.",
"value_type": "string"
}
},
"name": "resource name",
"variables": {
"Omnis earum deserunt aut vel.": {
"created": 1627590400,
"key": "r8k",
"updated": 1627686800,
"value": "Magnam eaque dolores deleniti in.",
"value_type": "string"
}
}
}{
"account": "a",
"created": 1627590400,
"description": "this is a more detailed explanation of the resource.",
"environment_variables": {
"Maiores quam.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
}
},
"identifier": "k4",
"name": "resource name",
"org": "2w",
"project": "k",
"type": "ansible",
"updated": 1627686800,
"variables": {
"Alias reprehenderit consequatur quidem aut aliquid expedita.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
},
"Recusandae necessitatibus.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
},
"Sit dolorem commodi nisi totam atque hic.": {
"created": 1627590400,
"key": "9",
"updated": 1627686800,
"value": "Voluptatum aut doloribus.",
"value_type": "json"
}
}
}Delete Configuration Variable Set by identifier on project level.
Org is the organisation identifier.
5swProject is the project identifier.
3Identifier is the Configuration Variable Set identifier.
rtAccount is the internal customer account ID.
mmkNo Content response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
DELETE /api/orgs/{org}/projects/{project}/configuration-variable-set/{identifier} HTTP/1.1
Host: localhost:80
Harness-Account: mmk
Accept: */*
No content
List the playbooks and inventories a Configuration Variable Set on project level is attached to.
Org is the organisation identifier.
dtProject is the project identifier.
1Identifier is the Configuration Variable Set identifier.
7dAccount is the internal customer account ID.
90rOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/configuration-variable-set/{identifier}/references HTTP/1.1
Host: localhost:80
Harness-Account: 90r
Accept: */*
{
"items": [
{
"account": "Molestiae dolor sed doloribus facere voluptas.",
"entity_type": "inventory",
"identifier": "Et accusamus eos modi recusandae consectetur repudiandae.",
"name": "Aut velit ea laudantium nesciunt.",
"org": "Voluptatem aut officia.",
"priority": 1037321779404229900,
"project": "Velit voluptatem soluta quaerat."
},
{
"account": "Molestiae dolor sed doloribus facere voluptas.",
"entity_type": "inventory",
"identifier": "Et accusamus eos modi recusandae consectetur repudiandae.",
"name": "Aut velit ea laudantium nesciunt.",
"org": "Voluptatem aut officia.",
"priority": 1037321779404229900,
"project": "Velit voluptatem soluta quaerat."
}
]
}Get Configuration Variable Set list on project level.
Org is the organisation identifier.
m8Project is the project identifier.
3Optional configuration product type to filter the list.
ansiblePossible values: Account is the internal customer account ID.
fucOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/configuration-variable-sets HTTP/1.1
Host: localhost:80
Harness-Account: fuc
Accept: */*
{
"items": [
{
"account": "w",
"created": 1627590400,
"description": "this is a more detailed explanation of the resource.",
"env_vars_count": 6097743661779087000,
"environment_variables": {
"Aperiam sapiente hic.": {
"created": 1627590400,
"key": "x",
"updated": 1627686800,
"value": "Tempore unde.",
"value_type": "json"
},
"Ea repudiandae iusto non.": {
"created": 1627590400,
"key": "x",
"updated": 1627686800,
"value": "Tempore unde.",
"value_type": "json"
},
"Et velit odio.": {
"created": 1627590400,
"key": "x",
"updated": 1627686800,
"value": "Tempore unde.",
"value_type": "json"
}
},
"identifier": "k8",
"name": "resource name",
"org": "ij",
"project": "gwc",
"type": "ansible",
"updated": 1627686800,
"variables": {
"Officia molestiae adipisci.": {
"created": 1627590400,
"key": "x",
"updated": 1627686800,
"value": "Tempore unde.",
"value_type": "json"
}
},
"vars_count": 175867220696504640
},
{
"account": "w",
"created": 1627590400,
"description": "this is a more detailed explanation of the resource.",
"env_vars_count": 6097743661779087000,
"environment_variables": {
"Aperiam sapiente hic.": {
"created": 1627590400,
"key": "x",
"updated": 1627686800,
"value": "Tempore unde.",
"value_type": "json"
},
"Ea repudiandae iusto non.": {
"created": 1627590400,
"key": "x",
"updated": 1627686800,
"value": "Tempore unde.",
"value_type": "json"
},
"Et velit odio.": {
"created": 1627590400,
"key": "x",
"updated": 1627686800,
"value": "Tempore unde.",
"value_type": "json"
}
},
"identifier": "k8",
"name": "resource name",
"org": "ij",
"project": "gwc",
"type": "ansible",
"updated": 1627686800,
"variables": {
"Officia molestiae adipisci.": {
"created": 1627590400,
"key": "x",
"updated": 1627686800,
"value": "Tempore unde.",
"value_type": "json"
}
},
"vars_count": 175867220696504640
}
]
}Last updated
Was this helpful?