さくらのVPS APIドキュメント
API docs by Redocly

さくらのVPS APIドキュメント (4.3.0)

Download OpenAPI specification:Download

URL: https://manual.sakura.ad.jp/vps/api/index.html License: Copyright(C) SAKURA internet Inc. all rights reserved. Terms of Service

「さくらのVPS」が提供するAPIの利用方法を公開しております。

「さくらのVPS」が提供するAPIはまだ一部の機能に制限しておりますが、順次機能を追加していく予定です。

本ドキュメントの著作権は、さくらインターネット株式会社に帰属しています。
法律によって認められる範囲を超えて、本ドキュメントを複製、改変、頒布その他の方法で利用することは一切禁止とします。
ただし、本ドキュメント内のコード(仕様として示しているリクエストとレスポンスの文字列すべてを指します)は、 CC BY 4.0 国際ライセンスで提供されます。

基本的な使い方

APIキーの発行

APIにアクセスするためには、認証のためのAPIキー（トークン文字列）が必要です。
APIキーの発行はVPSコントロールパネルから行えます。また、APIの機能としても提供しております。

初めてAPIキーを発行する場合は、VPSコントロールパネルから「ロールの追加」と「APIキーの追加」を行ってください。

操作マニュアル

このドキュメント内では発行したAPIキー（トークン文字列）の例としてSAMPLETOKENSAMPLETOKENSAMPLETOKと記載します。

APIへのリクエスト

  • APIのURLは https://secure.sakura.ad.jp/vps/api/v7/(エンドポイント) となります。
  • 認証方式はHTTP Bearer認証です。HTTPリクエストヘッダにAuthorization: Bearer SAMPLETOKENSAMPLETOKENSAMPLETOKを指定します。
    # リクエストのサンプル
curl -H 'Authorization: Bearer SAMPLETOKENSAMPLETOKENSAMPLETOK' \
   'https://secure.sakura.ad.jp/vps/api/v7/servers'

APIへのリクエスト結果

APIへのリクエストが成功したか失敗したかは、HTTPレスポンスのステータスコードで判断が可能です。

結果 ステータスコード
成功 (要求を受け付けた) 2xx
失敗（要求が受け付けられなかった） 4xx, 5xx

リクエストに成功すると、HTTPレスポンスのボディにはコンテンツ（データ）がJSON形式(UTF-8)で入っています。 ただしコンテンツ（データ）を返さないリクエストの場合はボディは空です。

# コンテンツ（データ）のサンプル
{
  "id": 1,
  "name": "sample_data"
}

リクエストに失敗すると、HTTPレスポンスのボディには失敗した理由などがJSON形式(UTF-8)で入っています。

# 失敗した場合のボディのサンプル
{
  "code": "not_found",
  "message": "見つかりませんでした"
}

APIリクエスト回数の制限(Rate Limiting)

  • 時間あたりに実行できるリクエスト回数に上限があります
    • 基本はご利用の アカウントごとに100リクエスト/1分 まで
  • リクエスト回数の上限に達した場合、リクエストは処理されず HTTPステータスコードが429 となります
  • これらの制限は、今後のお客様の利用状況により予告なく変更する場合があります

サーバー

サーバー情報一覧を取得する

Authorizations:
ApiKeyAuth
query Parameters
page
integer
per_page
integer [ 1 .. 100 ]
Default: 10
id
string

idで絞り込む。カンマ区切りで100件まで指定可能。

switch
integer

switchのid 対象のスイッチに接続されているサーバーに絞り込む

zone_code
string
Enum: "tk1" "tk2" "tk3" "os1" "os2" "os3" "is1"

ゾーンコードで絞り込む

  • tk1 東京第1
  • tk2 東京第2
  • tk3 東京第3
  • os1 大阪第1
  • os2 大阪第2
  • os3 大阪第3
  • is1 石狩第1
service_type
string
Enum: "linux" "windows"

サービスタイプで絞り込む

ipv4_address
string
Example: ipv4_address=192.0.2.0

IPアドレスで絞り込む

monitoring_resource_id
string

サーバー監視リソースIDで絞り込む

sort
string
Enum: "service_code" "-service_code" "name" "-name" "storage_size_gibibytes" "-storage_size_gibibytes" "memory_mebibytes" "-memory_mebibytes" "cpu_cores" "-cpu_cores" "hostname" "-hostname" "ipv6_hostname" "-ipv6_hostname" "ipv4_address" "-ipv4_address" "ipv6_address" "-ipv6_address" "zone_code" "-zone_code" "ipv4_ptr" "-ipv4_ptr" "ipv6_ptr" "-ipv6_ptr"

データの並び順。項目名の頭に-をつけると降順で取得する
例:

  • サービスコード昇順: sort=service_code
  • サービスコード降順: sort=-service_code
search
string

名前、説明文、ホスト名、ipv4アドレス、ipv6アドレス、サービスコードから部分一致検索

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "count": 100,
  • "next": "https://api.example.com/?page=3&per_page=10",
  • "previous": "https://api.example.com/?per_page=10"
}

サーバー情報を取得する

Authorizations:
ApiKeyAuth
path Parameters
server_id
required
integer

サーバーID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "service_type": "linux",
  • "service_status": "on_trial",
  • "cpu_cores": 2,
  • "memory_mebibytes": 1024,
  • "storage": [
    ],
  • "zone": {
    },
  • "options": [
    ],
  • "version": "v5",
  • "ipv4": {
    },
  • "ipv6": {
    },
  • "contract": {
    },
  • "power_status": "power_on"
}

サーバー情報を更新する

Authorizations:
ApiKeyAuth
path Parameters
server_id
required
integer

サーバーID

Request Body schema: application/json
name
required
string

名前

description
required
string

説明

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "service_type": "linux",
  • "service_status": "on_trial",
  • "cpu_cores": 2,
  • "memory_mebibytes": 1024,
  • "storage": [
    ],
  • "zone": {
    },
  • "options": [
    ],
  • "version": "v5",
  • "ipv4": {
    },
  • "ipv6": {
    },
  • "contract": {
    },
  • "power_status": "power_on"
}

サーバーの電源状態を取得する

Authorizations:
ApiKeyAuth
path Parameters
server_id
required
integer

サーバーID

Responses

Response samples

Content type
application/json
{
  • "status": "power_on"
}

サーバーを起動する

Authorizations:
ApiKeyAuth
path Parameters
server_id
required
integer

サーバーID

Responses

Response samples

Content type
application/json
{
  • "code": "not_authenticated",
  • "message": "認証情報が含まれていません。"
}

サーバーをシャットダウンする

Authorizations:
ApiKeyAuth
path Parameters
server_id
required
integer

サーバーID

Request Body schema: application/json
force
boolean
Default: false

強制停止を行うか

Responses

Request samples

Content type
application/json
{
  • "force": false
}

Response samples

Content type
application/json
{
  • "code": "not_authenticated",
  • "message": "認証情報が含まれていません。"
}

サーバーを強制再起動する

Authorizations:
ApiKeyAuth
path Parameters
server_id
required
integer

サーバーID

Responses

Response samples

Content type
application/json
{
  • "code": "not_authenticated",
  • "message": "認証情報が含まれていません。"
}

サーバーにディスクをマウントする

Authorizations:
ApiKeyAuth
path Parameters
server_id
required
integer

サーバーID

Request Body schema: application/json
disc_id
required
integer

ディスクID

Responses

Request samples

Content type
application/json
{
  • "disc_id": 0
}

Response samples

Content type
application/json
{
  • "code": "invalid",
  • "message": "Invalid input.",
  • "errors": {
    }
}

コンパネのVNCコンソールのキーマップ情報を取得する

Authorizations:
ApiKeyAuth
path Parameters
server_id
required
integer

サーバーID

Responses

Response samples

Content type
application/json
{
  • "layout": "ja"
}

コンパネのVNCコンソールのキーマップ情報を変更する

Authorizations:
ApiKeyAuth
path Parameters
server_id
required
integer

サーバーID

Request Body schema: application/json
layout
required
string
Enum: "ja" "en-us"

指定したいキー配列の名称

Responses

Request samples

Content type
application/json
{
  • "layout": "ja"
}

Response samples

Content type
application/json
{
  • "layout": "ja"
}

サーバーのipv4の逆引きホスト名を更新する

Authorizations:
ApiKeyAuth
path Parameters
server_id
required
integer

サーバーID

Request Body schema: application/json
hostname
required
string

ホスト名

Responses

Request samples

Content type
application/json
{
  • "hostname": "example.jp"
}

Response samples

Content type
application/json
{
  • "ptr": "example.jp"
}

サーバーのインターフェース情報一覧を取得する

Authorizations:
ApiKeyAuth
path Parameters
server_id
required
integer

サーバーID

Responses

Response samples

Content type
application/json
{}

サーバーのインターフェース情報を取得する

Authorizations:
ApiKeyAuth
path Parameters
server_id
required
integer

サーバーID

interface_id
required
integer

サーバーインターフェースID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "device": "eth0",
  • "connectable_to_global_network": true,
  • "connect_to": "global",
  • "mac": "9C:A3:BA:00:00:00",
  • "switch_id": 1
}

サーバーのインターフェース情報を更新する

Authorizations:
ApiKeyAuth
path Parameters
server_id
required
integer

サーバーID

interface_id
required
integer

サーバーインターフェースID

Request Body schema: application/json
switch_id
required
integer or null

スイッチID

Responses

Request samples

Content type
application/json
{
  • "switch_id": 1
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "device": "eth0",
  • "connectable_to_global_network": true,
  • "connect_to": "global",
  • "mac": "9C:A3:BA:00:00:00",
  • "switch_id": 1
}

サーバーのipv6の逆引きホスト名を更新する

Authorizations:
ApiKeyAuth
path Parameters
server_id
required
integer

サーバーID

Request Body schema: application/json
hostname
required
string

ホスト名

Responses

Request samples

Content type
application/json
{
  • "hostname": "example.jp"
}

Response samples

Content type
application/json
{
  • "ptr": "example.jp"
}

サーバーのビデオデバイスの設定を取得する

Authorizations:
ApiKeyAuth
path Parameters
server_id
required
integer

サーバーID

Responses

Response samples

Content type
application/json
{
  • "type": "vga"
}

サーバーのビデオデバイスの設定を更新する

Authorizations:
ApiKeyAuth
path Parameters
server_id
required
integer

サーバーID

Request Body schema: application/json
type
required
string
Enum: "vga" "cirrus"

ビデオデバイスの種類

Responses

Request samples

Content type
application/json
{
  • "type": "vga"
}

Response samples

Content type
application/json
{
  • "type": "vga"
}

サーバーの制限情報を取得する

Authorizations:
ApiKeyAuth
path Parameters
server_id
required
integer

サーバーID

Responses

Response samples

Content type
application/json
{
  • "cpu_performance_limit": "enabled",
  • "network_bandwidth_limit": "enabled",
  • "outbound_port_25_blocking": "enabled",
  • "storage_iops_limit": "enabled"
}

サーバーのサーバー監視情報一覧を取得する

Authorizations:
ApiKeyAuth
path Parameters
server_id
required
integer

サーバーID

query Parameters
page
integer
per_page
integer [ 1 .. 100 ]
Default: 10
monitoring_resource_id
string

サーバー監視リソースIDで絞り込む

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "count": 100,
  • "next": "https://api.example.com/?page=3&per_page=10",
  • "previous": "https://api.example.com/?per_page=10"
}

サーバーのサーバー監視を作成する

Authorizations:
ApiKeyAuth
path Parameters
server_id
required
integer

サーバーID

Request Body schema: application/json
name
required
string <= 255 characters

名前

description
required
string <= 10000 characters

説明

required
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "monitoring_resource_id": "string",
  • "update_status": "waiting",
  • "settings": {
    }
}

サーバーのサーバー監視情報を取得する

Authorizations:
ApiKeyAuth
path Parameters
server_id
required
integer

サーバーID

server_monitoring_id
required
integer

サーバー監視ID

query Parameters
page
integer
per_page
integer [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "monitoring_resource_id": "string",
  • "update_status": "waiting",
  • "settings": {
    }
}

サーバーのサーバー監視情報を更新する

Authorizations:
ApiKeyAuth
path Parameters
server_id
required
integer

サーバーID

server_monitoring_id
required
integer

サーバー監視ID

Request Body schema: application/json
name
required
string <= 255 characters

名前

description
required
string <= 10000 characters

説明

required
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "monitoring_resource_id": "string",
  • "update_status": "waiting",
  • "settings": {
    }
}

サーバーのサーバー監視情報を削除する

Authorizations:
ApiKeyAuth
path Parameters
server_id
required
integer

サーバーID

server_monitoring_id
required
integer

サーバー監視ID

Responses

Response samples

Content type
application/json
{
  • "code": "not_authenticated",
  • "message": "認証情報が含まれていません。"
}

サーバー監視の監視状態を取得する

Authorizations:
ApiKeyAuth
path Parameters
server_id
required
integer

サーバーID

server_monitoring_id
required
integer

サーバー監視ID

Responses

Response samples

Content type
application/json
{
  • "last_checked_at": "2024-04-15T23:59:59+09:00",
  • "status": "healthy",
  • "last_status_changed_at": "2024-04-01T23:59:59+09:00"
}

NFS

NFS情報一覧を取得する

Authorizations:
ApiKeyAuth
query Parameters
page
integer
per_page
integer [ 1 .. 100 ]
Default: 10
id
string

idで絞り込む。カンマ区切りで100件まで指定可能。

switch
integer

switchのid 対象のスイッチに接続されているサーバーに絞り込む

zone_code
string
Enum: "tk1" "tk2" "tk3" "os1" "os2" "os3" "is1"

ゾーンコードで絞り込む

  • tk1 東京第1
  • tk2 東京第2
  • tk3 東京第3
  • os1 大阪第1
  • os2 大阪第2
  • os3 大阪第3
  • is1 石狩第1
sort
string
Enum: "service_code" "-service_code" "name" "-name" "storage_size_gibibytes" "-storage_size_gibibytes" "ipv4_address" "-ipv4_address" "zone_code" "-zone_code"

データの並び順。項目名の頭に-をつけると降順で取得する
例:

  • サービスコード昇順: sort=service_code
  • サービスコード降順: sort=-service_code

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "count": 100,
  • "next": "https://api.example.com/?page=3&per_page=10",
  • "previous": "https://api.example.com/?per_page=10"
}

NFS情報を取得する

Authorizations:
ApiKeyAuth
path Parameters
nfs_server_id
required
integer

NFSのID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "service_status": "in_preparation",
  • "setting_status": "done",
  • "storage": [
    ],
  • "zone": {
    },
  • "ipv4": {
    },
  • "contract": {
    },
  • "power_status": "power_on"
}

NFS情報を更新する

Authorizations:
ApiKeyAuth
path Parameters
nfs_server_id
required
integer

NFSのID

Request Body schema: application/json
name
required
string

名前

description
required
string

説明

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "service_status": "in_preparation",
  • "setting_status": "done",
  • "storage": [
    ],
  • "zone": {
    },
  • "ipv4": {
    },
  • "contract": {
    },
  • "power_status": "power_on"
}

NFSのipv4を更新する

Authorizations:
ApiKeyAuth
path Parameters
nfs_server_id
required
integer

NFSのID

Request Body schema: application/json
address
required
string

ipv4アドレス

netmask
required
string

ネットマスク

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "netmask": "string"
}

Response samples

Content type
application/json
{
  • "code": "invalid",
  • "message": "Invalid input.",
  • "errors": {
    }
}

NFSの電源状態を取得する

Authorizations:
ApiKeyAuth
path Parameters
nfs_server_id
required
integer

NFSのID

Responses

Response samples

Content type
application/json
{
  • "status": "power_on"
}

NFSのインターフェースを取得する

Authorizations:
ApiKeyAuth
path Parameters
nfs_server_id
required
integer

NFSのID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "device": "eth0",
  • "connect_to": "switch",
  • "mac": "9C:A3:BA:00:00:00",
  • "switch_id": 1
}

NFSのインターフェース情報を更新する

Authorizations:
ApiKeyAuth
path Parameters
nfs_server_id
required
integer

NFSのID

Request Body schema: application/json
switch_id
required
integer or null

スイッチID

Responses

Request samples

Content type
application/json
{
  • "switch_id": 1
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "device": "eth0",
  • "connect_to": "switch",
  • "mac": "9C:A3:BA:00:00:00",
  • "switch_id": 1
}

スイッチ

スイッチを作成する

同一ゾーン内で作成可能なスイッチ数は最大20です

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

名前

description
required
string

説明

zone_code
required
string
Enum: "tk2" "tk3" "os3" "is1"

ゾーンコード

  • tk2 東京第2
  • tk3 東京第3
  • os3 大阪第3
  • is1 石狩第1

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "zone_code": "tk2"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "switch_code": "string",
  • "zone": {
    },
  • "server_interfaces": [ ],
  • "nfs_server_interfaces": [ ],
  • "external_connection": null
}

スイッチ情報一覧を取得する

Authorizations:
ApiKeyAuth
query Parameters
page
integer
per_page
integer [ 1 .. 100 ]
Default: 10
id
string

idで絞り込む。カンマ区切りで100件まで指定可能。

zone_code
string
Enum: "tk1" "tk2" "tk3" "os1" "os2" "os3" "is1"

ゾーンコードで絞り込む

  • tk1 東京第1
  • tk2 東京第2
  • tk3 東京第3
  • os1 大阪第1
  • os2 大阪第2
  • os3 大阪第3
  • is1 石狩第1
interface
integer

interfaceのid 対象のインターフェースに接続されているスイッチに絞り込む

sort
string
Enum: "name" "-name" "zone" "-zone" "interfaces_count" "-interfaces_count"

データの並び順。項目名の頭に-をつけると降順で取得する
例:

  • 接続インターフェース数昇順: sort=interfaces_count
  • 接続インターフェース数降順: sort=-interfaces_count
search
string

名前と説明文から部分一致検索

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "count": 100,
  • "next": "https://api.example.com/?page=3&per_page=10",
  • "previous": "https://api.example.com/?per_page=10"
}

スイッチ情報を取得する

Authorizations:
ApiKeyAuth
path Parameters
switch_id
required
integer

スイッチID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "switch_code": "string",
  • "zone": {
    },
  • "server_interfaces": [
    ],
  • "nfs_server_interfaces": [
    ],
  • "external_connection": {
    }
}

スイッチ情報を更新する

Authorizations:
ApiKeyAuth
path Parameters
switch_id
required
integer

スイッチID

Request Body schema: application/json
name
required
string

名前

description
required
string

説明

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "switch_code": "string",
  • "zone": {
    },
  • "server_interfaces": [
    ],
  • "nfs_server_interfaces": [
    ],
  • "external_connection": {
    }
}

スイッチを削除する

Authorizations:
ApiKeyAuth
path Parameters
switch_id
required
integer

スイッチID

Responses

Response samples

Content type
application/json
{
  • "code": "not_authenticated",
  • "message": "認証情報が含まれていません。"
}

ディスク

ディスク情報一覧を取得する

追加ソフトウェアのディスク情報です。WindowsのCDドライブにマウントして利用します。

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{}

ゾーン

ゾーン情報一覧を取得する

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{}

APIキー関連

APIキーを作成する

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string <= 100 characters

名前

role
required
integer

ロールID

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "role": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "role": 0,
  • "token": "string"
}

APIキーの一覧を取得する

Authorizations:
ApiKeyAuth
query Parameters
order
string
Enum: "id" "-id" "name" "-name"

データの並び順。項目名の頭に-をつけると降順で取得する
例:

  • 名称昇順: sort=name
  • 名称降順: sort=-name
role
integer

roleのid。ロールで絞り込む

search
string

名前から部分一致検索

Responses

Response samples

Content type
application/json
{}

APIキーを取得する

Authorizations:
ApiKeyAuth
path Parameters
api_key_id
required
integer

APIキーID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "role": 0,
  • "token": "string"
}

APIキーを更新する

Authorizations:
ApiKeyAuth
path Parameters
api_key_id
required
integer

APIキーID

Request Body schema: application/json
name
required
string <= 100 characters

名前

role
required
integer

ロールID

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "role": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "role": 0,
  • "token": "string"
}

APIキーを削除する

Authorizations:
ApiKeyAuth
path Parameters
api_key_id
required
integer

APIキーID

Responses

Response samples

Content type
application/json
{
  • "code": "not_authenticated",
  • "message": "認証情報が含まれていません。"
}

APIキーのトークンのローテーションを行う

Authorizations:
ApiKeyAuth
path Parameters
api_key_id
required
integer

APIキーID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "role": 0,
  • "token": "string"
}

ロールを作成する

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string <= 100 characters

名前

description
required
string <= 512 characters

説明

permission_filtering
required
string
Enum: "enabled" "disabled"

利用できる権限を制限するか

allowed_permissions
required
Array of strings

利用できる権限。permission_filteringがenabledの場合のみ指定可能。権限の一覧を取得する/permissionsのcode値を指定します。

resource_filtering
required
string
Enum: "enabled" "disabled"

利用できるリソースを制限するか

required
object or null

利用できるリソース。resource_filteringがenabledの場合のみ指定可能。

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "permission_filtering": "enabled",
  • "allowed_permissions": [
    ],
  • "resource_filtering": "enabled",
  • "allowed_resources": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "permission_filtering": "enabled",
  • "allowed_permissions": [
    ],
  • "resource_filtering": "enabled",
  • "allowed_resources": {
    }
}

ロール一覧を取得する

Authorizations:
ApiKeyAuth
query Parameters
order
string
Enum: "id" "-id" "name" "-name"

データの並び順。項目名の頭に-をつけると降順で取得する
例:

  • 名称昇順: sort=name
  • 名称降順: sort=-name
search
string

名前と説明文から部分一致検索

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "count": 100,
  • "next": "https://api.example.com/?page=3&per_page=10",
  • "previous": "https://api.example.com/?per_page=10"
}

ロールを取得する

Authorizations:
ApiKeyAuth
path Parameters
role_id
required
integer

ロールID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "permission_filtering": "enabled",
  • "allowed_permissions": [
    ],
  • "resource_filtering": "enabled",
  • "allowed_resources": {
    }
}

ロールを更新する

Authorizations:
ApiKeyAuth
path Parameters
role_id
required
integer

ロールID

Request Body schema: application/json
name
required
string <= 100 characters

名前

description
required
string <= 512 characters

説明

permission_filtering
required
string
Enum: "enabled" "disabled"

利用できる権限を制限するか

allowed_permissions
required
Array of strings

利用できる権限。permission_filteringがenabledの場合のみ指定可能。権限の一覧を取得する/permissionsのcode値を指定します。

resource_filtering
required
string
Enum: "enabled" "disabled"

利用できるリソースを制限するか

required
object or null

利用できるリソース。resource_filteringがenabledの場合のみ指定可能。

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "permission_filtering": "enabled",
  • "allowed_permissions": [
    ],
  • "resource_filtering": "enabled",
  • "allowed_resources": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "permission_filtering": "enabled",
  • "allowed_permissions": [
    ],
  • "resource_filtering": "enabled",
  • "allowed_resources": {
    }
}

ロールを削除する

Authorizations:
ApiKeyAuth
path Parameters
role_id
required
integer

ロールID

Responses

Response samples

Content type
application/json
{
  • "code": "not_authenticated",
  • "message": "認証情報が含まれていません。"
}

権限の一覧を取得する

Authorizations:
ApiKeyAuth
query Parameters
category
string
Example: category=server

カテゴリーで絞り込む

code
string
Example: code=get-server-list,get-server,put-server

コードで絞り込む。カンマ区切りで複数指定可能。

Responses

Response samples

Content type
application/json
{}