API 참조
API 작업을 사용하고 결과를 해석하십시오
사용 가능한 엔드포인트, 멱등성 규칙, 대기 작업 응답 및 작업 추적에 대한 현재 제한을 읽으십시오.
시작하기 전에
- 유효한 세션과 보호된 변경의 경우 해당 CSRF 토큰.
- 현재 카탈로그 또는 인증된 API 응답에서 가져온 식별자.
- 각 주문, 출금 또는 하드웨어 작업에 대한 고유한 멱등성 키.
변경하기 전에 계정을 읽으세요
읽기 엔드포인트를 사용하여 계정, 잔액 및 대상 리소스를 확인하십시오. GET /api/v1/me은(는) username, balanceUsd 및 세션의 csrfToken을 반환합니다. 리소스 식별자는 계정별로 다릅니다. 다른 환경에서 값을 복사하지 말고 현재 계정에 대해 반환된 서버 또는 네트워크 식별자를 사용하십시오.
현재 API는 완전한 비동기 작업 플랫폼이 아닌 간결한 계정 인터페이스입니다. 성공적인 쓰기에서 참조를 자체 기록에 저장하십시오. 모든 주문을 나열하거나 특정 대기 중인 작업을 검사하거나 출금의 최신 검토 상태를 검색하는 엔드포인트가 없습니다.
| 엔드포인트 읽기 | 반환된 데이터 |
|---|---|
| GET /api/v1/ledger | 최신 100 원장 항목, 최신순; 페이지 매김 계약 없음. |
| GET /api/v1/servers | 종료되지 않은 서버, 상태, 지역, paidThrough, graceUntil 및 autoRenew. |
| GET /api/v1/network | 할당된 주소, 접두사 길이, PTR 값 및 관련 서버 식별자. |
| GET /api/health | 기본 서비스 및 카탈로그 수; 계정 또는 물리적 서버 상태 보장 없음. |
일치하는 변경 엔드포인트를 사용하세요
지원되는 서버 작업은 재부팅, power_off, 재설치, mount_iso, kvm 및 rotate_root_password입니다. 사용자 지정 ISO URL은 자격 증명이 포함되지 않은 공개 HTTPS를 사용해야 합니다. 주문 기간은 주간 또는 월간이며 각각 7일 또는 30일을 나타냅니다. 가격, 할인, 자금 및 용량은 서비스에서 확인하므로 클라이언트가 계산한 가격을 권위로 보내지 마십시오.
| 엔드포인트 | 요청 필드 및 결과 |
|---|---|
| POST /api/v1/orders | configId, regionId, osId, term, quantity; 선택적 sshPublicKey. 주문 ID와 ACCEPTED를 반환합니다. |
| POST /api/v1/deposit-addresses | 자산. 반환 주소, 자산, 네트워크, confirmationsRequired 및 모드, 또는 결제 불가 오류. |
| POST /api/v1/withdrawals | 자산, 대상, usd. id와 PENDING_REVIEW를 반환하며 잔액이 보류됩니다. |
| POST /api/v1/servers/{id}/actions | 작업; mount_iso에 대한 isoUrl. 작업 ID와 QUEUED를 반환합니다. |
| PUT /api/v1/servers/{id}/ddos | 모드: BASELINE 또는 ADVANCED. QUEUED 또는 UNCHANGED 및 quoteRequired를 반환합니다. |
| PUT /api/v1/network/{id}/rdns | ptr 또는 지우기 위한 빈 값. 저장된 PTR 값을 반환합니다. |
재시도를 신중하게 하십시오
주문, 출금, 서버 작업 및 DDoS 요청에는 Idempotency-Key가 필요합니다. 8–100 문자, 숫자, 하이픈 또는 밑줄을 사용하고, 각각의 의도된 작업마다 새 키를 할당하십시오. 불확실한 응답을 조사할 수 있도록 전송 전에 원래 키, 리소스 및 페이로드를 보존하십시오.
주문은 동일한 키와 정규화된 요청에 대해 기존 결과를 재생할 수 있으며, 변경된 주문 세부 정보는 충돌을 생성합니다. 서버 작업 재생은 호환 가능한 경우 기존 작업을 반환합니다. 계정의 모든 서버에서 작업 키를 고유하게 유지하십시오. 출금은 이미 기록된 경우 원래 요청을 성공으로 반환하지 않고 충돌을 보고합니다.
POST /api/v1/servers/{serverId}/actions HTTP/1.1
Content-Type: application/json
x-csrf-token: <current-session-token>
Idempotency-Key: <unique-operation-key>
Cookie: <current-session-cookies>
{"action":"reboot"}수락과 완료 구분
202 QUEUED 응답은 하드웨어 요청이 기록되었음을 확인합니다. 여기에는 작동하는 KVM URL, 교체된 루트 비밀번호 또는 시스템 재시작 증거가 포함되지 않습니다. 마찬가지로 ACCEPTED는 주문이 프로비저닝 단계에 진입했음을 기록하며, PENDING_REVIEW는 출금 요청이 운영자 검토를 기다리고 있음을 기록합니다. 실행에 대해 문의할 때는 반환된 식별자를 보존하세요.
이 버전에는 작업 상태 폴링 경로가 없습니다. 관련된 경우 서버 또는 네트워크 데이터를 다시 읽고 물리적 효과에 대한 운영자 확인을 받으세요. 저장된 PTR 또는 DDoS 기본 설정만으로는 공용 DNS 또는 실시간 네트워크 보호를 측정할 수 없습니다.
작업을 중복하지 않고 실패에 대응
- 400 유효성 검사 오류: 다시 제출하기 전에 문서화된 필드를 수정하세요.
- 401 또는 403: 재시도 전에 세션 인증 또는 CSRF 확인을 수리하세요.
- 404: 리소스 식별자가 로그인된 계정에 속하는지 확인하세요.
- 409: 오류 코드를 검사하세요. 잔액 부족, 용량 소진, 멱등성 충돌은 서로 다른 대응이 필요합니다.
- 입금 시 502 또는 503: 사용 가능한 새 주소가 반환되지 않았습니다. 전송을 시작하지 마십시오.
- 시간 초과 또는 읽을 수 없는 응답: 사용 가능한 계정 기록을 확인하고 원래 요청 세부 정보를 보존하세요. 새 작업 키를 무작정 생성하지 마세요.