Skip to main content
PATCH
/
v1
/
admin
/
platforms
/
{platform_id}
Update platform
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    logo_url: '<string>',
    support_email: 'jsmith@example.com',
    support_url: '<string>',
    status: '<string>'
  })
};

fetch('https://api.keystoneos.xyz/v1/admin/platforms/{platform_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "auth0_org_id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "status": "<string>",
  "logo_url": "<string>",
  "support_email": "<string>",
  "support_url": "<string>",
  "onboarding_completed_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "environment_count": 0
}

Documentation Index

Fetch the complete documentation index at: https://docs.keystoneos.xyz/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Auth0 JWT access token. See Authentication for details.

Path Parameters

​
platform_id
string<uuid>
required

Body

application/json

Admin-level platform update. Extends client update with status changes.

​
name
string | null
​
logo_url
string | null
​
support_email
string<email> | null
​
support_url
string | null
​
status
string | null

Response

Successful Response

Platform as seen by an admin, including environment count.

​
id
string<uuid>
required
​
auth0_org_id
string | null
required
​
name
string
required
​
slug
string
required
​
status
string
required
​
logo_url
string | null
required
​
support_email
string | null
required
​
support_url
string | null
required
​
onboarding_completed_at
string<date-time> | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
environment_count
integer
default:0