Tham chiếu API
Không gian làm việcGET

Lấy workspace hiện tại

Trả về không gian làm việc gắn với tiêu đề X-Api-Key. Không cần gửi workspace_id trong nội dung yêu cầu.

https://api.unifyport.ai/v1/workspace

Tiêu đề

X-Api-Key
stringbắt buộc

API key của không gian làm việc. Không gian làm việc được xác định từ tiêu đề này.

Tham số đường dẫn

Điểm cuối này không có tham số đường dẫn.

Nội dung yêu cầu

Điểm cuối này không cần nội dung JSON.

Nội dung phản hồi

name
string

Tên hiển thị của workspace.

status
string

Trạng thái vòng đời của workspace, ví dụ active.

metadata
object

Nhãn môi trường của riêng bạn được lưu trên workspace.

account_quota
number

Số tài khoản nhà cung cấp tối đa được phép trong workspace này.

account_quota_unlimited
boolean

Khi true, hạn mức tài khoản là không giới hạn và account_quota bị bỏ qua.

Phản hồi

200
200 OK

Yêu cầu thành công. Xem ví dụ nội dung phản hồi.

400
Bad Request

Body, đường dẫn hoặc tham số yêu cầu không hợp lệ.

401
Unauthorized

Header X-Api-Key thiếu hoặc không hợp lệ.

409
Conflict

Thao tác đang yêu cầu xung đột với tài khoản hoặc tài nguyên nhà cung cấp đã có.

500
Internal Server Error

Dịch vụ gặp lỗi không mong muốn.

Yêu cầu

curl -X GET https://api.unifyport.ai/v1/workspace \
  -H "X-Api-Key: <YOUR_API_KEY>"

Phản hồi

{
  "data": {
    "name": "Production Workspace",
    "status": "active",
    "metadata": {
      "env": "production"
    },
    "account_quota": 10,
    "account_quota_unlimited": false
  }
}