Patch a device setting

patch/compute-ops-mgmt/v1beta1/settings/{id}

Partially update a device settings item.

SecurityBearer
Request
path Parameters
id
required
string <uuid>
header Parameters
Content-Type
required
string

Content-Type header must designate 'application/merge-patch+json' in order for the request to be performed.

Value: "application/merge-patch+json"
Tenant-Acid
string <uuid>

Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.

In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts API to determine the application customer IDs for your tenant accounts.

Request Body schema: application/merge-patch+json
required
name
string [ 1 .. 100 ] characters

The display name for the setting

description
string or null <= 10000 characters

The description for the setting

object

Configuration data corresponding to the specified category

Responses
200

Successful Response

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

406

Not acceptable

415

Unsupported media type

500

Internal server error

Request samples
application/merge-patch+json
{
  • "name": "string",
  • "description": "string",
  • "settings": {
    }
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "category": "BIOS",
  • "settings": {
    },
  • "generation": 1,
  • "resourceUri": "/compute-ops-mgmt/v1beta1/settings/a2fdaf7a-4933-4c47-bfe0-891f0a83dc6e",
  • "type": "compute-ops-mgmt/setting",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}