API Log API (1.0.0-oas3)
Download OpenAPI specification:Download
Register object storage credential
Authorizations:
Request Body schema: application/json
register object storage
One of
- postStorageWasabi
- postStorageAzure
storageProvider required | object (storageProviderWasabi) |
Responses
201
success
400
validationエラー
401
認証エラー
403
アクセスエラー
500
サーバエラー
post/storages
https://example.com/v2/apilog/storages
Request samples
- Payload
Content type
application/json
Example
postStorageWasabi
Copy
Expand all Collapse all {- "storageProvider": {
- "name": "wasabi",
- "accessKey": "7LAE9QIXTI2Y61WZ1UGZ",
- "secretAccessKey": "q2JGUBUWy3woT4HuYN2DiZbZIjwZuqPV7SQiuMBq",
- "endpoint": "s3.ap-northeast-1-ntt.wasabisys.com",
- "bucket": "apilog"
}
}
Response samples
- 201
- 400
- 401
- 403
- 500
Content type
application/json
Example
storageInfoWasabi
Copy
Expand all Collapse all {- "storageProvider": {
- "name": "wasabi",
- "accessKey": "7LAE9QIXTI2Y61WZ1UGZ",
- "secretAccessKey": "q2JGUBUWy3woT4HuYN2DiZbZIjwZuqPV7SQiuMBq",
- "endpoint": "s3.ap-northeast-1-ntt.wasabisys.com",
- "bucket": "apilog"
}, - "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
- 200
- 400
- 401
- 403
- 500
Content type
application/json
Example
storageStatusWasabi
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}
https://example.com/v2/apilog/storages/{storageUuid}
Response samples
- 401
Content type
application/json
Copy
Expand all Collapse all {- "fault": {
- "faultstring": "string",
- "detail": {
- "errorcode": "string"
}
}
}
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
- 201
- 400
- 401
- 403
- 500
Content type
application/json
Example
storageStatusWasabi
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"
}
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
- 201
- 400
- 401
- 403
- 500
Content type
application/json
Copy
Expand all Collapse all {- "message": "dummy data is queued"
}