← เอกสารอ้างอิง API
พื้นที่ทำงานGET

ดูพื้นที่ทำงานปัจจุบัน

คืนพื้นที่ทำงานที่ผูกกับส่วนหัว X-Api-Key ไม่ต้องส่ง workspace_id ในเนื้อหาของคำขอ

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

ส่วนหัว

X-Api-Key
stringจำเป็น

API key ของพื้นที่ทำงาน ระบบจะระบุพื้นที่ทำงานจากส่วนหัวนี้

พารามิเตอร์ใน path

จุดเชื่อมต่อนี้ไม่มีพารามิเตอร์ใน path

เนื้อหาของคำขอ

จุดเชื่อมต่อนี้ไม่ต้องใช้เนื้อหา JSON

เนื้อหาการตอบกลับ

name
string

ชื่อแสดงผลของ workspace

status
string

สถานะ lifecycle ของ workspace เช่น active

metadata
object

label สภาพแวดล้อมของคุณเองที่เก็บไว้บน workspace

account_quota
number

จำนวนบัญชีของผู้ให้บริการสูงสุดที่อนุญาตใน workspace นี้

account_quota_unlimited
boolean

เมื่อเป็น true โควตาบัญชีจะไม่จำกัด และค่า account_quota จะถูกละเว้น

การตอบกลับ

200
200 OK

คำขอสำเร็จ ดูตัวอย่างเนื้อหาตอบกลับด้านบน

400
Bad Request

เนื้อหาของคำขอ path หรือพารามิเตอร์ไม่ถูกต้อง

401
Unauthorized

ส่วนหัว X-Api-Key หายไปหรือไม่ถูกต้อง

409
Conflict

การดำเนินการขัดแย้งกับบัญชีของผู้ให้บริการหรือทรัพยากรที่มีอยู่

500
Internal Server Error

บริการพบข้อผิดพลาดที่ไม่คาดคิด

คำขอ

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

การตอบกลับ

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