Retrieve all persisted roles.
200- (
RoleAggregates) The role aggregates.
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Create a Blueprinter role.
(RoleAggregateCreateData) (required) The data you want to use for creating a role.
201- (
RoleAggregate) The role aggregate that was just created. 409(
BasicFailedReply) The role ID you specified is already in use. (code:roles.already_exists)Headers
x-cloud-error-codes(string; allowed values: [roles.already_exists])- The error codes associated with the response
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
curl -XPOST {{hostname}}/api/v1/platform/infrastructure/blueprinter/roles \
-H "Authorization: ApiKey $CLOUD_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
"blessings" : {
"runner_ids_to_blessing" : {
"some_property" : {
"value" : true
}
}
},
"role" : {
"auto_blessed" : true,
"containers" : [
{
"container_set_name" : "string",
"kind" : "string",
"name" : "string",
"options" : {
"acls" : [
{
"id" : "string",
"perms" : 0,
"scheme" : "string"
}
],
"auths" : [
{
"auth" : "string",
"scheme" : "string"
}
],
"container_set_secret" : "string",
"enabled" : true,
"enabled_by_named_feature_flag" : "string",
"overrides" : {
"container_config" : {
"env" : [
"string"
],
"host_config" : {
"binds" : [
"string"
],
"cpu_period" : 0,
"extra_hosts" : [
"string"
],
"network_mode" : "string",
"port_bindings" : {
"some_property" : {
"host_ip" : "string",
"host_port" : "string"
}
},
"privileged" : true,
"restart_policy" : {
"maximum_retry_count" : 0,
"name" : "string"
}
}
}
},
"runners_secret" : "string"
}
}
],
"id" : "string"
}
}
'Delete a role.
| Name | Type | Required | Description |
|---|---|---|---|
|
| Y | User-specified Blueprinter role ID. |
| Name | Type | Required | Description |
|---|---|---|---|
|
| N | When specified, checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request) |
200- (
EmptyResponse) The role was successfully deleted. 400(
BasicFailedReply) The role is currently running container sets. (code:roles.in_use)Headers
x-cloud-error-codes(string; allowed values: [roles.in_use])- The error codes associated with the response
404(
BasicFailedReply) The role can't be found. (code:roles.not_found)Headers
x-cloud-error-codes(string; allowed values: [roles.not_found])- The error codes associated with the response
409(
BasicFailedReply) Your request failed because the specified version does not match the persisted version. (code:roles.version_conflict)Headers
x-cloud-error-codes(string; allowed values: [roles.version_conflict])- The error codes associated with the response
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Retrieve a role.
| Name | Type | Required | Description |
|---|---|---|---|
|
| Y | User-specified Blueprinter role ID. |
200- (
RoleAggregate) The role aggregate definition. 404(
BasicFailedReply) The role can't be found. (code:roles.not_found)Headers
x-cloud-error-codes(string; allowed values: [roles.not_found])- The error codes associated with the response
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Update a role.
| Name | Type | Required | Description |
|---|---|---|---|
|
| Y | User-specified Blueprinter role ID. |
| Name | Type | Required | Description |
|---|---|---|---|
|
| N | When specified, checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request) |
(Role) (required) The role update data.
200- (
RoleAggregate) The role was successfully updated. 400(
BasicFailedReply) The role is currently running container sets. (code:roles.in_use)Headers
x-cloud-error-codes(string; allowed values: [roles.in_use])- The error codes associated with the response
404(
BasicFailedReply) The role can't be found. (code:roles.not_found)Headers
x-cloud-error-codes(string; allowed values: [roles.not_found])- The error codes associated with the response
409(
BasicFailedReply) Your request failed because the specified version does not match the persisted version. (code:roles.version_conflict)Headers
x-cloud-error-codes(string; allowed values: [roles.version_conflict])- The error codes associated with the response
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
curl -XPUT {{hostname}}/api/v1/platform/infrastructure/blueprinter/roles/{blueprinter_role_id} \
-H "Authorization: ApiKey $CLOUD_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
"auto_blessed" : true,
"containers" : [
{
"container_set_name" : "string",
"kind" : "string",
"name" : "string",
"options" : {
"acls" : [
{
"id" : "string",
"perms" : 0,
"scheme" : "string"
}
],
"auths" : [
{
"auth" : "string",
"scheme" : "string"
}
],
"container_set_secret" : "string",
"enabled" : true,
"enabled_by_named_feature_flag" : "string",
"overrides" : {
"container_config" : {
"env" : [
"string"
],
"host_config" : {
"binds" : [
"string"
],
"cpu_period" : 0,
"extra_hosts" : [
"string"
],
"network_mode" : "string",
"port_bindings" : {
"some_property" : {
"host_ip" : "string",
"host_port" : "string"
}
},
"privileged" : true,
"restart_policy" : {
"maximum_retry_count" : 0,
"name" : "string"
}
}
}
},
"runners_secret" : "string"
}
}
],
"id" : "string"
}
'Set blessings for a role.
| Name | Type | Required | Description |
|---|---|---|---|
|
| Y | User-specified Blueprinter role ID. |
| Name | Type | Required | Description |
|---|---|---|---|
|
| N | When specified, checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request) |
(Blessings) (required) The blessings to set.
200- (
RoleAggregate) The blessings were successfully set. 404(
BasicFailedReply) The role can't be found. (code:roles.not_found)Headers
x-cloud-error-codes(string; allowed values: [roles.not_found])- The error codes associated with the response
409(
BasicFailedReply) Your request failed because the specified version does not match the persisted version. (code:roles.version_conflict)Headers
x-cloud-error-codes(string; allowed values: [roles.version_conflict])- The error codes associated with the response
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Add a Blessing for a runner to a role.
PUT /api/v1/platform/infrastructure/blueprinter/roles/{blueprinter_role_id}/blessings/{runner_id}
| Name | Type | Required | Description |
|---|---|---|---|
|
| Y | User-specified Blueprinter role ID. |
|
| Y | Runner ID for a blessing associated with a role. |
| Name | Type | Required | Description |
|---|---|---|---|
|
| N | When specified, checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request) |
(Blessing) (required) The blessing to add.
200- (
RoleAggregate) Blessing added successfully. 404(
BasicFailedReply) The role can't be found. (code:roles.not_found)Headers
x-cloud-error-codes(string; allowed values: [roles.not_found])- The error codes associated with the response
409(
BasicFailedReply) Your request failed because the specified version does not match the persisted version. (code:roles.version_conflict)Headers
x-cloud-error-codes(string; allowed values: [roles.version_conflict])- The error codes associated with the response
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.