Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Delete compute service
description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Deletes a compute service. All compute versions under the service must already be stopped or deleted.'
full: true
_openapi:
method: DELETE
Expand All @@ -14,10 +15,7 @@ _openapi:
path: '/v1/compute-services/{computeServiceId}'
url: '/management-api/endpoints/[experimental]/delete-compute-services-by-compute-service-id'
metaTitle: 'DELETE /v1/compute-services/{computeServiceId} | Delete compute service'
metaDescription: |-
Management API: ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️

Deletes a compute service. All compute versions under the service must already be stopped or deleted.
metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Deletes a compute service. All compute versions under the service must already be stopped or deleted.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Delete compute version
description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Permanently deletes the compute version, its metadata, and any associated VM. The version must be stopped or in the `new` state before it can be deleted.'
full: true
_openapi:
method: DELETE
Expand All @@ -14,10 +15,7 @@ _openapi:
path: '/v1/compute-services/versions/{versionId}'
url: '/management-api/endpoints/[experimental]/delete-compute-services-versions-by-version-id'
metaTitle: 'DELETE /v1/compute-services/versions/{versionId} | Delete compute version'
metaDescription: |-
Management API: ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️

Permanently deletes the compute version, its metadata, and any associated VM. The version must be stopped or in the `new` state before it can be deleted.
metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Permanently deletes the compute version, its metadata, and any associated VM. The version must be stopped or in the `new` state before it can be deleted.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Delete compute version
description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Permanently deletes the compute version, its metadata, and any associated VM. The version must be stopped or in the `new` state before it can be deleted.'
full: true
_openapi:
method: DELETE
Expand All @@ -14,10 +15,7 @@ _openapi:
path: '/v1/versions/{versionId}'
url: '/management-api/endpoints/[experimental]/delete-versions-by-version-id'
metaTitle: 'DELETE /v1/versions/{versionId} | Delete compute version'
metaDescription: |-
Management API: ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️

Permanently deletes the compute version, its metadata, and any associated VM. The version must be stopped or in the `new` state before it can be deleted.
metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Permanently deletes the compute version, its metadata, and any associated VM. The version must be stopped or in the `new` state before it can be deleted.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: List compute versions
description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Returns all compute versions belonging to a compute service, ordered by creation time (newest first). Supports cursor-based pagination.'
full: true
_openapi:
method: GET
Expand All @@ -14,10 +15,7 @@ _openapi:
path: '/v1/compute-services/{computeServiceId}/versions'
url: '/management-api/endpoints/[experimental]/get-compute-services-by-compute-service-id-versions'
metaTitle: 'GET /v1/compute-services/{computeServiceId}/versions | List compute versions'
metaDescription: |-
Management API: ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️

Returns all compute versions belonging to a compute service, ordered by creation time (newest first). Supports cursor-based pagination.
metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Returns all compute versions belonging to a compute service, ordered by creation time (newest first). Supports cursor-based pagination.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Get compute service
description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Returns a compute service by ID, including its region and latest version reference.'
full: true
_openapi:
method: GET
Expand All @@ -14,10 +15,7 @@ _openapi:
path: '/v1/compute-services/{computeServiceId}'
url: '/management-api/endpoints/[experimental]/get-compute-services-by-compute-service-id'
metaTitle: 'GET /v1/compute-services/{computeServiceId} | Get compute service'
metaDescription: |-
Management API: ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️

Returns a compute service by ID, including its region and latest version reference.
metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Returns a compute service by ID, including its region and latest version reference.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Get compute version
description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Returns a compute version by ID, including its current status derived from the underlying VM state.'
full: true
_openapi:
method: GET
Expand All @@ -14,10 +15,7 @@ _openapi:
path: '/v1/compute-services/versions/{versionId}'
url: '/management-api/endpoints/[experimental]/get-compute-services-versions-by-version-id'
metaTitle: 'GET /v1/compute-services/versions/{versionId} | Get compute version'
metaDescription: |-
Management API: ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️

Returns a compute version by ID, including its current status derived from the underlying VM state.
metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Returns a compute version by ID, including its current status derived from the underlying VM state.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: List compute services
description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Returns all compute services the token has access to, ordered by creation time (oldest first). Optionally filter by project ID. Supports cursor-based pagination.'
full: true
_openapi:
method: GET
Expand All @@ -14,10 +15,7 @@ _openapi:
path: /v1/compute-services
url: '/management-api/endpoints/[experimental]/get-compute-services'
metaTitle: GET /v1/compute-services | List compute services
metaDescription: |-
Management API: ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️

Returns all compute services the token has access to, ordered by creation time (oldest first). Optionally filter by project ID. Supports cursor-based pagination.
metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Returns all compute services the token has access to, ordered by creation time (oldest first). Optionally filter by project ID. Supports cursor-based pagination.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: List compute services for a project
description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Returns all compute services belonging to a project, ordered by creation time (oldest first). Supports cursor-based pagination.'
full: true
_openapi:
method: GET
Expand All @@ -14,10 +15,7 @@ _openapi:
path: '/v1/projects/{projectId}/compute-services'
url: '/management-api/endpoints/[experimental]/get-projects-by-project-id-compute-services'
metaTitle: 'GET /v1/projects/{projectId}/compute-services | List compute services for a project'
metaDescription: |-
Management API: ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️

Returns all compute services belonging to a project, ordered by creation time (oldest first). Supports cursor-based pagination.
metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Returns all compute services belonging to a project, ordered by creation time (oldest first). Supports cursor-based pagination.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Get compute version
description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Returns a compute version by ID, including its current status derived from the underlying VM state.'
full: true
_openapi:
method: GET
Expand All @@ -14,10 +15,7 @@ _openapi:
path: '/v1/versions/{versionId}'
url: '/management-api/endpoints/[experimental]/get-versions-by-version-id'
metaTitle: 'GET /v1/versions/{versionId} | Get compute version'
metaDescription: |-
Management API: ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️

Returns a compute version by ID, including its current status derived from the underlying VM state.
metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Returns a compute version by ID, including its current status derived from the underlying VM state.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: List compute versions
description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Returns all compute versions the token has access to, ordered by creation time (newest first). Optionally filter by compute service ID. Supports cursor-based pagination.'
full: true
_openapi:
method: GET
Expand All @@ -14,10 +15,7 @@ _openapi:
path: /v1/versions
url: '/management-api/endpoints/[experimental]/get-versions'
metaTitle: GET /v1/versions | List compute versions
metaDescription: |-
Management API: ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️

Returns all compute versions the token has access to, ordered by creation time (newest first). Optionally filter by compute service ID. Supports cursor-based pagination.
metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Returns all compute versions the token has access to, ordered by creation time (newest first). Optionally filter by compute service ID. Supports cursor-based pagination.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Update compute service
description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Updates the display name of a compute service.'
full: true
_openapi:
method: PATCH
Expand All @@ -14,10 +15,7 @@ _openapi:
path: '/v1/compute-services/{computeServiceId}'
url: '/management-api/endpoints/[experimental]/patch-compute-services-by-compute-service-id'
metaTitle: 'PATCH /v1/compute-services/{computeServiceId} | Update compute service'
metaDescription: |-
Management API: ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️

Updates the display name of a compute service.
metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Updates the display name of a compute service.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Promote compute version
description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Promotes a compute version to be the active version behind the service''s stable endpoint. The version must be running. Returns the service endpoint domain.'
full: true
_openapi:
method: POST
Expand All @@ -14,10 +15,7 @@ _openapi:
path: '/v1/compute-services/{computeServiceId}/promote'
url: '/management-api/endpoints/[experimental]/post-compute-services-by-compute-service-id-promote'
metaTitle: 'POST /v1/compute-services/{computeServiceId}/promote | Promote compute version'
metaDescription: |-
Management API: ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️

Promotes a compute version to be the active version behind the service's stable endpoint. The version must be running. Returns the service endpoint domain.
metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Promotes a compute version to be the active version behind the service''s stable endpoint. The version must be running. Returns the service endpoint domain.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Create compute version
description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Creates a new compute version under the specified compute service. Returns a pre-signed upload URL for the artifact unless `skipCodeUpload` is set (which forks the latest version''s artifact). Environment variables are merged with the previous version''s variables when one exists.'
full: true
_openapi:
method: POST
Expand All @@ -14,10 +15,7 @@ _openapi:
path: '/v1/compute-services/{computeServiceId}/versions'
url: '/management-api/endpoints/[experimental]/post-compute-services-by-compute-service-id-versions'
metaTitle: 'POST /v1/compute-services/{computeServiceId}/versions | Create compute version'
metaDescription: |-
Management API: ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️

Creates a new compute version under the specified compute service. Returns a pre-signed upload URL for the artifact unless `skipCodeUpload` is set (which forks the latest version's artifact). Environment variables are merged with the previous version's variables when one exists.
metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Creates a new compute version under the specified compute service. Returns a pre-signed upload URL for the artifact unless `skipCodeUpload` is set (which forks the latest version''s artifact). Environment variables are merged with the previous version''s variables when one exists.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Start compute version
description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Requests VM creation and startup for the compute version. The artifact must be uploaded before calling this endpoint. Returns a preview domain that becomes reachable once the VM is running. Poll the status endpoint until `running` is reached.'
full: true
_openapi:
method: POST
Expand All @@ -14,10 +15,7 @@ _openapi:
path: '/v1/compute-services/versions/{versionId}/start'
url: '/management-api/endpoints/[experimental]/post-compute-services-versions-by-version-id-start'
metaTitle: 'POST /v1/compute-services/versions/{versionId}/start | Start compute version'
metaDescription: |-
Management API: ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️

Requests VM creation and startup for the compute version. The artifact must be uploaded before calling this endpoint. Returns a preview domain that becomes reachable once the VM is running. Poll the status endpoint until `running` is reached.
metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Requests VM creation and startup for the compute version. The artifact must be uploaded before calling this endpoint. Returns a preview domain that becomes reachable once the VM is running. Poll the status endpoint until `running` is reached.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Stop compute version
description: 'Experimental endpoint: this API is in active development and may change at any time without notice. Requests VM shutdown for the compute version. The version record and metadata are retained. Poll the status endpoint until `stopped` is reached.'
full: true
_openapi:
method: POST
Expand All @@ -14,10 +15,7 @@ _openapi:
path: '/v1/compute-services/versions/{versionId}/stop'
url: '/management-api/endpoints/[experimental]/post-compute-services-versions-by-version-id-stop'
metaTitle: 'POST /v1/compute-services/versions/{versionId}/stop | Stop compute version'
metaDescription: |-
Management API: ⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️

Requests VM shutdown for the compute version. The version record and metadata are retained. Poll the status endpoint until `stopped` is reached.
metaDescription: 'Management API: Experimental endpoint: this API is in active development and may change at any time without notice. Requests VM shutdown for the compute version. The version record and metadata are retained. Poll the status endpoint until `stopped` is reached.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Loading
Loading