For the complete documentation index, see llms.txt. This page is also available as Markdown.

专用服务器

⚡ 部署

[v2] Deploy

post

[Rate Limit: 40 req/s] Create a new deployment - containerized instance of an application version.

授权
Authorizationstring必填
头参数
Acceptstring可选Example: */*
Content-Typestring可选Example: application/json
请求体
applicationstring必填

Name of the application that will be deployed

Example: my-game-server
versionstring必填

Name of the version within the application that will be deployed

Example: 25.05.30-16.45.19-04
require_cached_locationsboolean · 可为 null可选

Deploy faster by limiting placement to locations with cached image.

Default: false
tagsstring[]可选

List of tags to associate with the deployment

Example: my-custom-tag
响应
post
/deployments

Get Deployment

get

[Rate Limit: 20 req/s] Get the specified deployment status and information.

授权
Authorizationstring必填
路径参数
deployment_idstring必填Example: 61b1be8f54d9
头参数
Acceptstring可选Example: */*
Content-Typestring可选Example: application/json
响应
200

Success

application/json
request_idstring必填

ID of your deployment, also referred to as request ID.

Example: c0653765de3b
fqdnstring必填

FQDN (URL) to connect to the deployment.

Example: c0653765de3b.pr.edgegap.net
public_ipstring必填

Public IP address of the host.

Example: 192.53.120.48
app_namestring必填

Application which has been deployed.

Example: test
app_versionstring必填

App version which has been deployed.

Example: v1
current_statusstring必填

Indicates whether deployment is Ready, in Error, or otherwise.

Example: Status.SEEKING
runningboolean必填

True if deployment is Ready for connections.

Default: trueExample: true
start_timestring · date-time必填

Timestamp of deployment becoming Ready.

Example: 2026-04-22 12:00:46.444265
elapsed_timeinteger必填

Seconds since deployment becoming Ready.

max_durationinteger · 最小值: -1 · 最大值: 1440必填

Maximum allowed uptime minutes of deployments before automatically stopped.

Example: 1440
removal_timestring · date-time可选

Timestamp of deployment stopped.

Example: 2026-04-22 12:00:46.444265
last_statusstring可选

Previous status of deployment.

Example: Status.SEEKING
errorboolean必填

Indicates an error with the deployment.

Default: falseExample: true
error_detailstring可选

Details of the error.

Example: Pull image timeout exceeded
tagsstring[]可选

List of tags to mark your deployments for easy filtering.

Example: production
commandstring可选

Overrides container command for the deployment, use with caution.

Example: echo "hi" && sleep infinity
argumentsstring可选

Overrides container arguments for the deployment, use with caution.

get
/v1/status/{deployment_id}

List Deployments

get

[Rate Limit: 10 req/s] List all deployments, optionally filtered and sorted.

授权
Authorizationstring必填
查询参数
querystring可选

Query to filter the deployments. See filtering guide. For client integrations, consider Server Browser instead.

Example: {"filters":[{"field":"status","operator":"eq","value":"ready"}]}
pageinteger · 最小值: 1可选Example: 2
limitinteger · 最小值: 1可选Example: 20
头参数
Acceptstring可选Example: */*
Content-Typestring可选Example: application/json
响应
200

Success

application/json
messagestring[]可选

Additional information related to your query.

Example: [""]
total_countinteger必填Example: 100
get
/v1/deployments

Stop Deployment

delete

Request to stop a deployment from your custom backend, triggering a graceful shutdown (SIGTERM). Returns 200 or 202 if deployment status is not READY and not ERROR, and stops deployment once either of these statuses is reached - see Deployment Lifecycle.

授权
Authorizationstring必填
路径参数
deployment_idstring必填Example: 61b1be8f54d9
查询参数
container_log_storagestring可选

Enable or disable previously configured log storage. Alternatively, provide endpoint storage ID to override or set storage to upload logs.

Example: true
头参数
Acceptstring可选Example: */*
Content-Typestring可选Example: application/json
响应
200

Success

application/json
messagestring必填

Additional information regarding deployment termination.

Example: 1a9e4ff02cce - Delete request will be processed soon
delete
/v1/stop/{deployment_id}

Stop Deployments

post

Delete multiple deployments using custom filtering. Caution is advised.

授权
Authorizationstring必填
头参数
Acceptstring可选Example: */*
Content-Typestring可选Example: application/json
请求体
响应
post
/v1/deployments/bulk-stop

Self-Stop Deployment

delete

Delete a deployment from the inside of a container, available as injected variable ARBITRIUM_DELETE_URL.

授权
Authorizationstring必填
路径参数
deployment_idstring必填Example: 61b1be8f54d9
stop_keystring必填Example: 660
查询参数
container_log_storagestring可选

Enable or disable previously configured log storage. Alternatively, provide endpoint storage ID to override or set storage to upload logs.

Example: true
头参数
authorizationstring必填

Auto Generated token. This token is injected in your deployment and can be found via the environment variable named ARBITRIUM_DELETE_TOKEN

Acceptstring可选Example: */*
Content-Typestring可选Example: application/json
响应
200

Success

application/json
any可选
delete
/v1/self/stop/{deployment_id}/{stop_key}

无内容

Get Deployment Logs

get

Retrieve the logs of your container, if Endpoint Storage was configured before stopping the deployment.

授权
Authorizationstring必填
路径参数
deployment_idstring必填

ID of your deployment, also referred to as request ID.

Example: 61b1be8f54d9
头参数
Acceptstring可选Example: */*
Content-Typestring可选Example: application/json
响应
200

Success

application/json
logsstring可选

Plaintext deployment success logs.

Example: Logs of the container
crash_logsstring · 可为 null可选

Plaintext deployment crash logs.

Example: Logs of the container when it crashed
encodingstring可选

Encoding used for logs.

Example: utf-8
logs_linkstring · 可为 null可选

Link to retrieve logs from your configured Endpoint Storage.

get
/v1/deployment/{deployment_id}/container-logs

Get Deployment Metrics

get

Get metrics for the specified deployment in a given time range.

授权
Authorizationstring必填
路径参数
deployment_idstring必填Example: 61b1be8f54d9
查询参数
start_timestring · date-time可选

Start of reporting time range, defaults to deployment start time.

Example: 2021-07-10 00:00:00.00
end_timestring · date-time可选

End of reporting time range, default to deployment stopped time. Must be greater than start time.

Example: 2021-07-10 00:00:00.00
stepsstring可选

Size of reporting time step between metric values, aggregated using average (mean).

Example: 30s
rawboolean可选

Optionally enable raw output.

Default: falseExample: false
头参数
Acceptstring可选Example: */*
Content-Typestring可选Example: application/json
响应
200

Success

application/json
get
/v1/metrics/deployment/{deployment_id}

🗺️ 私有舰队

Deploy to Fleet

post

[Rate Limit: 40/seconds] Initiate a new private fleet deployment. A deployment is a containerized server instance of an application version running on the Edgegap platform.

授权
Authorizationstring必填
头参数
Acceptstring可选Example: */*
Content-Typestring可选Example: application/json
请求体
private_host_idsstring[] · 最小值: 1必填

Preferred and prioritized Private Host IDs to try before overflowing to cloud.

Example: alpha-north-america-95fab093
applicationstring必填

Name of the application that will be deployed

Example: my-game-server
versionstring必填

Name of the version within the application that will be deployed

Example: 25.05.30-16.45.19-04
require_cached_locationsboolean · 可为 null可选

Deploy faster by limiting placement to locations with cached image.

Default: false
tagsstring[]可选

List of tags to associate with the deployment

Example: my-custom-tag
响应
post
/private-fleets/deployments

List Private Fleet Hosts

get

[Rate Limit: 10/seconds] List all hosts in a private fleet.

授权
Authorizationstring必填
路径参数
fleet-namestring必填

Name of your private fleet.

Example: test-fleet
头参数
Acceptstring可选Example: */*
Content-Typestring可选Example: application/json
响应
200成功
application/json
total_countinteger必填Example: 100
get
/private-fleets/{fleet-name}/hosts

🔖 标签

Create Tag

post

Create a tag for the specified deployment. Does not modify injected variables in a running deployment.

授权
Authorizationstring必填
路径参数
deployment_idstring必填Example: f68e011bfb01
头参数
Acceptstring可选Example: */*
Content-Typestring可选Example: application/json
请求体
namestring · 最小值: 1 · 最大值: 40必填

Name of the tag.

Example: development
响应
200

Success

application/json
namestring · 最小值: 1 · 最大值: 40必填

Name of the tag.

Example: development
create_timestring · date-time可选

Date of creation.

Example: 2026-04-22 20:30:52.283949
last_updatedstring · date-time可选

Date of last update.

Example: 2026-04-22 20:30:52.283949
post
/v1/deployments/{deployment_id}/tags

Get Tag

get

Get tag from the specified deployment.

授权
Authorizationstring必填
路径参数
deployment_idstring必填Example: f68e011bfb01
tag_namestring必填Example: player-id-1234
头参数
Acceptstring可选Example: */*
Content-Typestring可选Example: application/json
响应
200

Success

application/json
namestring · 最小值: 1 · 最大值: 40必填

Name of the tag.

Example: development
create_timestring · date-time可选

Date of creation.

Example: 2026-04-22 20:30:52.283949
last_updatedstring · date-time可选

Date of last update.

Example: 2026-04-22 20:30:52.283949
get
/v1/deployments/{deployment_id}/tags/{tag_name}

List Tags

get

List tags from the specified deployment.

授权
Authorizationstring必填
路径参数
deployment_idstring必填Example: f68e011bfb01
查询参数
pageinteger · 最小值: 1可选Example: 2
limitinteger · 最小值: 1可选Example: 20
头参数
Acceptstring可选Example: */*
Content-Typestring可选Example: application/json
响应
200

Success

application/json
total_countinteger必填Example: 100
get
/v1/deployments/{deployment_id}/tags

Update Tag

patch

Update a tag for the specified deployment. Does not modify injected variables.

授权
Authorizationstring必填
路径参数
deployment_idstring必填Example: f68e011bfb01
tag_namestring必填Example: player-id-1234
头参数
Acceptstring可选Example: */*
Content-Typestring可选Example: application/json
请求体
namestring · 最小值: 1 · 最大值: 40必填

Name of the tag.

Example: development
响应
200

Success

application/json
namestring · 最小值: 1 · 最大值: 40必填

Name of the tag.

Example: development
create_timestring · date-time可选

Date of creation.

Example: 2026-04-22 20:30:52.283949
last_updatedstring · date-time可选

Date of last update.

Example: 2026-04-22 20:30:52.283949
patch
/v1/deployments/{deployment_id}/tags/{tag_name}

Delete Tag

delete

Delete a tag for a deployment. Does not modify injected variables.

授权
Authorizationstring必填
路径参数
deployment_idstring必填Example: f68e011bfb01
tag_namestring必填Example: player-id-1234
头参数
Acceptstring可选Example: */*
Content-Typestring可选Example: application/json
响应
delete
/v1/deployments/{deployment_id}/tags/{tag_name}

无内容

最后更新于

这有帮助吗?