Powered by Redocly

Site profiles

Site profile is a set of configuration settings that can be assigned to a site.

Create a new site profile

SecurityaccessToken
Request
query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Request Body schema:
name
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

The name of the profile.

Array of objects
Array of objects
Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict (instance exists)

503

Service Unavailable (strongbox sealed)

post/v1/config/system/site-profiles
Request samples 
name: sweden
maintenance-windows:
  - days-of-week: Friday, Saturday
    start-time: 01:00
    timezone: UTC
    duration: 4h
application-upgrade-windows:
  - days-of-week: Friday, Saturday
    start-time: 01:00
    timezone: UTC
    duration: 4h

Retrieve the configuration of all site profiles

SecurityaccessToken
Request
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"
keys
string <enumeration>

Retrieve only the keys for the list

Value: "true"
count
string <enumeration>

Retrieve only the number of elements in the list

Value: "true"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

get/v1/config/system/site-profiles
Response samples 
- name: sweden
  maintenance-windows:
    - days-of-week: Friday, Saturday
      start-time: 01:00
      timezone: UTC
      duration: 4h
  application-upgrade-windows:
    - days-of-week: Friday, Saturday
      start-time: 01:00
      timezone: UTC
      duration: 4h

Update a site profile

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

The name of the profile.

query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Request Body schema:
name
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

The name of the profile.

Array of objects
Array of objects
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/system/site-profiles/{site-profile-name}
Request samples 
name: sweden
maintenance-windows:
  - days-of-week: Friday, Saturday
    start-time: 01:00
    timezone: UTC
    duration: 4h
application-upgrade-windows:
  - days-of-week: Friday, Saturday
    start-time: 01:00
    timezone: UTC
    duration: 4h

Delete a site profile

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

The name of the profile.

query Parameters
validate
string <enumeration>

Validate the request but do 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/system/site-profiles/{site-profile-name}

Replace or create a new site profile

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

The name of the profile.

query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Request Body schema:
name
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

The name of the profile.

Array of objects
Array of objects
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/system/site-profiles/{site-profile-name}
Request samples 
name: sweden
maintenance-windows:
  - days-of-week: Friday, Saturday
    start-time: 01:00
    timezone: UTC
    duration: 4h
application-upgrade-windows:
  - days-of-week: Friday, Saturday
    start-time: 01:00
    timezone: UTC
    duration: 4h

Retrieve the configuration of a site profile

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

The name of the profile.

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

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

get/v1/config/system/site-profiles/{site-profile-name}
Response samples 
name: sweden
maintenance-windows:
  - days-of-week: Friday, Saturday
    start-time: 01:00
    timezone: UTC
    duration: 4h
application-upgrade-windows:
  - days-of-week: Friday, Saturday
    start-time: 01:00
    timezone: UTC
    duration: 4h

Retrieve the state of all site profiles

SecurityaccessToken
Request
query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

content
string <enumeration>

Filter descendant nodes in the response

Enum: "config" "nonconfig"
keys
string <enumeration>

Retrieve only the keys for the list

Value: "true"
count
string <enumeration>

Retrieve only the number of elements in the list

Value: "true"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/system/site-profiles
Response samples 
- name: sweden
  maintenance-windows:
    - days-of-week: Friday, Saturday
      start-time: 01:00
      timezone: UTC
      duration: 4h
  application-upgrade-windows:
    - days-of-week: Friday, Saturday
      start-time: 01:00
      timezone: UTC
      duration: 4h

Retrieve the state of a site profile

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

The name of the profile.

query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

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/system/site-profiles/{site-profile-name}
Response samples 
name: sweden
maintenance-windows:
  - days-of-week: Friday, Saturday
    start-time: 01:00
    timezone: UTC
    duration: 4h
application-upgrade-windows:
  - days-of-week: Friday, Saturday
    start-time: 01:00
    timezone: UTC
    duration: 4h
➔ Next to Sites