Skip to main content
PATCH
/
v1
/
regions
/
{region}
/
projects
/
{project}
/
infrastructure
/
servers
/
{id}
Update server metadata
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    displayName: '<string>',
    description: '<string>',
    tags: {},
    persona: '<string>'
  })
};

fetch('https://api.k0rdent.ai/v1/regions/{region}/projects/{project}/infrastructure/servers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "selfLink": "/v1/regions/us-texas-1/projects/project-x9y8z7/infrastructure/servers/server-p7q8r9",
  "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "server-p7q8r9",
  "displayName": "<string>",
  "description": "<string>",
  "hardwareSpecs": {
    "cpu": {},
    "ram": {},
    "gpu": {}
  },
  "bmcAddress": "<string>",
  "provisioningState": "registered",
  "healthStatus": {
    "status": "healthy",
    "lastCheckTime": "2023-11-07T05:31:56Z",
    "failureReasons": [
      "<string>"
    ]
  },
  "tags": {},
  "persona": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication using OAuth2/OIDC tokens

Path Parameters

​
region
string
required

Region identifier

​
project
string
required

Project identifier

​
id
string<uuid>
required

Unique server identifier (UUID)

Body

application/json

Request to update server metadata

​
displayName
string

Updated human-friendly display name for the server.

​
description
string

Updated description of this resource.

​
tags
object

Updated metadata tags

​
persona
string

Updated persona assignment

Response

Server updated successfully

Bare metal server resource

​
selfLink
string<uri>

Server-defined URL for this resource.

Example:

"/v1/regions/us-texas-1/projects/project-x9y8z7/infrastructure/servers/server-p7q8r9"

​
uid
string<uuid>

Server-generated UUID.

​
id
string

Name of the resource. Provided by the client when the resource is created, or generated by the server if not specified. Must be 1-63 characters long and match the pattern a-z? — the first character must be a lowercase letter, and all following characters must be lowercase letters, digits, or hyphens, with the last character being a letter or digit. Cannot be changed after the resource is created.

Required string length: 1 - 63
Pattern: ^[a-z]([-a-z0-9]*[a-z0-9])?$
Example:

"server-p7q8r9"

​
displayName
string

Optional human-friendly display name for the server.

​
description
string

An optional description of this resource.

​
hardwareSpecs
object

Hardware specifications

​
bmcAddress
string

Baseboard Management Controller address

​
provisioningState
enum<string>

Current provisioning state

Available options:
registered,
provisioning,
ready,
failed,
decommissioned
​
healthStatus
object

Host health information

​
tags
object

Host metadata tags

​
persona
string

Assigned persona/role for the host

​
createdAt
string<date-time>

Creation timestamp

​
updatedAt
string<date-time>

Last update timestamp