Powered by Redocly

Assigned Site Settings

Tenant-specific settings for an assigned site.

Update the assigned site settings

SecurityaccessToken
Request
path Parameters
assigned-site-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of assigned-site

query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
dry-run
string <enumeration>

Check which other resources would be impacted by this operation, but does not actually perform the requested operation

Value: "true"
Request Body schema:
object

Map of string keys and values that can be used to organize and categorize (scope and select) objects.

In addition to the configured labels, all labels configured by the site provider, and the system-provided labels in the list below are added by the system to the operational state, which means that they are available for matching.

  • system/name: contains the value of the site's name
  • system/type: contains the value of the site's type

A label name consists of an optional prefix followed by /, followed by a name segment. The optional prefix is a DNS host name (must match inet:domain-name). The name segment must match ava:name.

The prefix system is used for labels assigned by the system.

Label names without prefixes are reserved for application owners.

For example:

  • system/controller
  • example.com/location.city
  • example.com/color
  • color
assigned-site-profile
string <leafref>

Reference to a site profile applied to this site.

Note that these site profile settings might be overridden by inherited site profile settings created by site provider tenant(s).

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

patch/v1/config/assigned-sites/{assigned-site-name}/settings
Request samples 
labels:
  region: sw-west
assigned-site-profile: sweden

Delete the assigned site settings

SecurityaccessToken
Request
path Parameters
assigned-site-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of assigned-site

query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
dry-run
string <enumeration>

Check which other resources would be impacted by this operation, but does not actually perform the requested operation

Value: "true"
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

delete/v1/config/assigned-sites/{assigned-site-name}/settings

Replace or create the assigned site settings

SecurityaccessToken
Request
path Parameters
assigned-site-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of assigned-site

query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
dry-run
string <enumeration>

Check which other resources would be impacted by this operation, but does not actually perform the requested operation

Value: "true"
Request Body schema:
object

Map of string keys and values that can be used to organize and categorize (scope and select) objects.

In addition to the configured labels, all labels configured by the site provider, and the system-provided labels in the list below are added by the system to the operational state, which means that they are available for matching.

  • system/name: contains the value of the site's name
  • system/type: contains the value of the site's type

A label name consists of an optional prefix followed by /, followed by a name segment. The optional prefix is a DNS host name (must match inet:domain-name). The name segment must match ava:name.

The prefix system is used for labels assigned by the system.

Label names without prefixes are reserved for application owners.

For example:

  • system/controller
  • example.com/location.city
  • example.com/color
  • color
assigned-site-profile
string <leafref>

Reference to a site profile applied to this site.

Note that these site profile settings might be overridden by inherited site profile settings created by site provider tenant(s).

Responses
201

Created

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

put/v1/config/assigned-sites/{assigned-site-name}/settings
Request samples 
labels:
  region: sw-west
assigned-site-profile: sweden

Retrieve the configuration of assigned site settings

SecurityaccessToken
Request
path Parameters
assigned-site-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of assigned-site

query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Responses
200

OK

304

Not Modified

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

get/v1/config/assigned-sites/{assigned-site-name}/settings
Response samples 
labels:
  region: sw-west
assigned-site-profile: sweden

Retrieve the the state of assigned site settings

SecurityaccessToken
Request
path Parameters
assigned-site-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of assigned-site

query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

site
string

Send the request to the specfifed site

content
string <enumeration>

Filter descendant nodes in the response

Enum: "config" "nonconfig"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/assigned-sites/{assigned-site-name}/settings
Response samples 
labels:
  region: sw-west
assigned-site-profile: sweden
➔ Next to Assigned Sites