VPS.org API 문서화

시작하기

VPS.org API를 사용하면 서버, 도메인, DNS 레코드, 백업 및 스냅샷을 포함한 VPS 호스팅 인프라의 모든 측면을 프로그래밍 방식으로 관리할 수 있습니다.

입증

모든 API 요청에는 베어러 토큰을 사용한 인증이 필요합니다. 계정 설정에서 API 토큰을 생성할 수 있습니다. admin.vps.org/account/developers/.

cURL

Python

JavaScript

curl -X GET https://admin.vps.org/api/v1/servers/ \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

import requests

url = "https://admin.vps.org/api/v1/servers/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch('https://admin.vps.org/api/v1/servers/', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);

각 토큰은 servers:list 또는 dns:*와 같은 자체 권한을 가지고 있습니다. 토큰이 가지지 않은 권한이 필요한 요청은 403과 누락된 권한을 명시한 required_permission 필드로 거부됩니다. 권한 참조

속도 제한

인증된 요청은 계정당 시간당 1,000개로 제한되며 인증되지 않은 요청은 IP 주소당 시간당 100개로 제한됩니다. 제한을 초과하는 요청은 429와 함께 Retry-After 헤더를 받아 대기 시간을 초로 표시합니다. 성공적인 응답에 대해 속도 제한 헤더가 전송되지 않습니다.

페이지 형식

목록 끝점은 페이지당 25개의 항목을 가진 목적지를 반환합니다. 페이지 사이를 이동하려면 페이지를 넘기거나, URL이 null이 될 때까지 다음 URL을 따르십시오. 서버 목록은 page_size 를 최대 100까지 받아들입니다.

{
  "count": 84,
  "next": "https://admin.vps.org/api/v1/backups/?page=2",
  "previous": null,
  "results": [ ... ]
}

오류 처리

API는 표준 HTTP 상태 코드를 사용하여 성공 또는 실패를 나타냅니다.

상태 코드	설명
`200`	성공 - 요청이 성공적으로 완료되었습니다.
`201`	생성됨 - 리소스가 성공적으로 생성되었습니다
`400`	잘못된 요청 - 유효하지 않은 매개변수 또는 잘못된 형식의 요청입니다.
`202`, `204`	승인되고 대기열에 올랐습니다(202), 또는 응답 본문 없이 삭제되었습니다(204)
`402`	지불 필수: 파일에 지불 방법이 없거나, 미지급 청구서 또는 거절된 카드 사전 승인
`403`	Forbidden: 토큰이 누락되거나, 잘못되었거나, 만료되었거나, 필요한 권한이 없습니다. 인증 실패시 401이 아닌 403을 반환합니다.
`404`	찾을 수 없음 - 리소스가 존재하지 않습니다.
`409`	충돌: 예를 들어 이미 진행 중인 크기 조정, 충분한 용량이 없거나 이미 실행 중인 배포
`429`	요청이 너무 많습니다 - 속도 제한 초과
`500`	내부 서버 오류 - 저희 시스템에 문제가 발생했습니다.
`503`	서비스 사용 불가: 임시 문제. 다시 시도, Retry-After를 보낼 때 존중합니다.