Skip to main content
获取项目信息
curl --request GET \
  --url https://api.example.com/api/v1/projects/{project_id} \
  --header 'X-API-Key: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "status": true,
  "expires_at": 123,
  "created_at": 123,
  "statistics": {
    "total_codes": 123,
    "used_codes": 123,
    "unused_codes": 123,
    "disabled_codes": 123,
    "expired_codes": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.codegateapp.com/llms.txt

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

Returns the project’s details: name, description, status, validity, and code statistics (total, used, unused, disabled, expired). The path project_id must match the project bound to the current API Key.

Authorizations

​
X-API-Key
string
header
required

API Key + X-Timestamp + X-Signature（HMAC-SHA256）

Path Parameters

​
project_id
string
required

项目 ID（32 位 UUID，无连字符）

Response

项目信息

​
id
string
​
name
string
​
description
string
​
status
boolean
​
expires_at
integer | null
​
created_at
integer
​
statistics
object