API Log API (1.0.0-oas3)

Download OpenAPI specification:Download

Authentication

Bearer

Credentials of access token for API

Security Scheme Type HTTP
HTTP Authorization Scheme bearer

Show object storage list

Authorizations:

Responses

200

show storage info

401

認証エラー

403

アクセスエラー

500

サーバエラー

get/storages
https://example.com/v2/apilog/storages

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "storages":
    [
    ]
}

Register object storage credential

Authorizations:
Request Body schema: application/json

register object storage

storageProvider
required
object (storageProvider)

Responses

201

success

400

validationエラー

401

認証エラー

403

アクセスエラー

500

サーバエラー

post/storages
https://example.com/v2/apilog/storages

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "storageProvider":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "storageProvider":
    {
    },
  • "storageUuid": "aaaaa"
}

Show object storage information

Authorizations:
path Parameters
storageUuid
required
string

storage Information id given by UUID

Responses

200

show storage info

400

validationエラー

401

認証エラー

403

アクセスエラー

404

未存在エラー

500

サーバエラー

get/storages/{storageUuid}
https://example.com/v2/apilog/storages/{storageUuid}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "ac7c5df8-fd22-4de0-abf6-40530ee7d597",
  • "name": "wasabi",
  • "endpoint": "s3.ap-northeast-1-ntt.wasabisys.com",
  • "bucket": "apilog",
  • "status": "activated"
}

update status

Authorizations:
path Parameters
storageUuid
required
string

storage Information id given by UUID

query Parameters
activated
required
boolean
Enum: true false

Responses

201

show storage updated info

400

validationエラー

401

認証エラー

403

アクセスエラー

404

未存在エラー

500

サーバエラー

post/storages/{storageUuid}?activated=true
https://example.com/v2/apilog/storages/{storageUuid}?activated=true

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "ac7c5df8-fd22-4de0-abf6-40530ee7d597",
  • "name": "wasabi",
  • "endpoint": "s3.ap-northeast-1-ntt.wasabisys.com",
  • "bucket": "apilog",
  • "status": "activated"
}

delete object storage information

Authorizations:
path Parameters
storageUuid
required
string

storage Information id given by UUID

Responses

204

success

401

認証エラー

404

未存在エラー

delete/storages/{storageUuid}?activated=true
https://example.com/v2/apilog/storages/{storageUuid}?activated=true

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "fault":
    {
    }
}

validate object storage credential by uploading dummy data

Authorizations:
path Parameters
storageUuid
required
string

storage Information id given by UUID

Responses

201

success

400

validationエラー

401

認証エラー

403

アクセスエラー

404

未存在エラー

500

サーバエラー

post/storages/{storageUuid}/validate
https://example.com/v2/apilog/storages/{storageUuid}/validate

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "message": "dummy data is queued"
}