Object Storage API (v2.1.0)
Managing account information, container options and domains, creating log exports, and more.
Get account information and container statistics
Returns general account information and containers statistics.
Authorizations:
iam_token_project_scoped
Responses
/v2/account/info
Response samples
- 200
- 401
- default
Content type
application/json
{- "bytes_used": 123321,
- "containers_count": 123321,
- "object_count": 123321,
- "quota_bytes": 123321,
- "status": "string",
- "storage_policies_stats": {
- "policy-0": {
- "bytes_used": 123,
- "containers_count": 123,
- "object_count": 123
}
}
}Set up account quotas
Sets up account quotas of bytes.
Authorizations:
iam_token_project_scoped
Request Body schema: application/jsonrequired
Set up account quotas
| quota_bytes | integer <uint64> Setting storage account max bytes used quota in bytes, null value means quota does not exist |
Responses
/v2/account/quotas
Request samples
- Payload
Content type
application/json
{- "quota_bytes": 1024
}Response samples
- 200
- 401
- default
Content type
application/json
{- "quota_bytes": 123321
}Delete container domains
Deletes specified domains bound to container.
Authorizations:
iam_token_project_scoped
Request Body schema: application/jsonrequired
Container Domains
| domains | Array of strings |
Responses
/v2/containers/{container_name}/domains
Request samples
- Payload
Content type
application/json
{- "domains": [
- "some.domain.com",
- "another.domain.com"
]
}Response samples
- 400
- 401
- 403
- 404
- 422
- default
Content type
application/json
{- "code": "string",
- "message": "error description"
}Add a domain to container
Adds specified domain to container.
Authorizations:
iam_token_project_scoped
Request Body schema: application/jsonrequired
Container Domains
| domain_name | string |
Responses
/v2/containers/{container_name}/domains
Request samples
- Payload
Content type
application/json
{- "domain_name": "some.domain.com"
}Response samples
- 401
- 403
- 404
- 409
- 422
- default
Content type
application/json
{- "code": "string",
- "message": "error description"
}Get list of container domains and certificates
Retrieves domains and their certificates bound to container.
Authorizations:
iam_token_project_scoped
Responses
/v2/containers/{container_name}/domains/certs
Response samples
- 200
- 401
- 403
- 404
- 422
- default
Content type
application/json
{- "domains": [
- "test-domain.com",
- "another-domain.com"
]
}Get container options
Returns actual container options.
Authorizations:
iam_token_project_scoped
path Parameters
| container_name required | string Container name |
Responses
/v2/containers/{container_name}/options
Response samples
- 200
- 401
- 403
- 422
- default
Content type
application/json
{- "general": {
- "cache_control": "no-cache",
- "default_delete_after": 3600,
- "type": "private"
}, - "quota": {
- "max_bytes_used": 1024,
- "max_object_count": 10
}, - "web": {
- "error": "error.html",
- "error_status_code": 200,
- "index": "index.html",
- "listing_css": "style.css",
- "listing_enabled": true
}
}Set container options
Sets container options.
Authorizations:
iam_token_project_scoped
path Parameters
| container_name required | string Container name |
Request Body schema: application/jsonrequired
Container options
object (ContainerGeneralOptionsBodySwagger) | |
object (ContainerQuotaOptionsBodySwagger) | |
object (ContainerWebOptionsBodySwagger) |
Responses
/v2/containers/{container_name}/options
Request samples
- Payload
Content type
application/json
{- "general": {
- "cache_control": "max-age=604800",
- "default_delete_after": 3600,
- "type": "private"
}, - "quota": {
- "max_bytes_used": 1024,
- "max_object_count": 10
}, - "web": {
- "error": "error.html",
- "error_status_code": 200,
- "index": "index.html",
- "listing_css": "style.css",
- "listing_enabled": true
}
}Response samples
- 200
- 400
- 401
- 403
- 422
- default
Content type
application/json
{- "general": {
- "cache_control": "no-cache",
- "default_delete_after": 3600,
- "type": "private"
}, - "quota": {
- "max_bytes_used": 1024,
- "max_object_count": 10
}, - "web": {
- "error": "error.html",
- "error_status_code": 200,
- "index": "index.html",
- "listing_css": "style.css",
- "listing_enabled": true
}
}Get list of logs export tasks
Returns a list of log tasks. A task is an asynchronous entity, its processing progress should be tracked.
query Parameters
| limit | integer <uint64> Limit |
| offset | integer <uint64> Offset |
| order_by | string OrderBy |
Responses
/v2/logs
Response samples
- 200
- 400
- 401
- 403
- default
Content type
application/json
{- "tasks": [
- {
- "task": {
- "created": "2019-05-14T06:00:00",
- "data": {
- "container": "target_container",
- "delete_after": 3600,
- "fields": [
- "string"
], - "filters": {
- "property1": null,
- "property2": null
}, - "provider": "storage_access",
- "since": "2019-05-14T06:00:00",
- "till": "2019-05-14T06:00:00"
}, - "finished": "2019-05-14T06:00:00",
- "id": "string",
- "response": {
- "objects": [
- "3c9d2cf2-56f0-4ccb-9433-d47209739828/storage_access_20240919T00:00:00-20240926T19:30:00.log.zip",
- "4c0d3cf3-67f1-5ccb-0544-d58310840939/storage_access_20240926T00:00:00-20240930T20:40:00.log.zip"
]
}, - "type": "string",
- "updated": "2019-05-14T06:00:00"
}
}
]
}Create new logs export tasks
Creates new task and returns it. Task is async entity, and you need track processing progress.
Authorizations:
iam_token_project_scoped
Request Body schema: application/jsonrequired
Log task body
object | |
| type | string |
Responses
/v2/logs
Request samples
- Payload
Content type
application/json
{- "data": {
- "container": "string",
- "delete_after": 0,
- "fields": [
- "string"
], - "filters": {
- "property1": null,
- "property2": null
}, - "provider": "string",
- "since": "2019-05-14T06:00:00",
- "till": "2019-05-14T06:00:00"
}, - "type": "string"
}Response samples
- 200
- 400
- 401
- 403
- default
Content type
application/json
{- "task": {
- "created": "2019-05-14T06:00:00",
- "data": {
- "container": "target_container",
- "delete_after": 3600,
- "fields": [
- "string"
], - "filters": {
- "property1": null,
- "property2": null
}, - "provider": "storage_access",
- "since": "2019-05-14T06:00:00",
- "till": "2019-05-14T06:00:00"
}, - "finished": "2019-05-14T06:00:00",
- "id": "string",
- "response": {
- "objects": [
- "3c9d2cf2-56f0-4ccb-9433-d47209739828/storage_access_20240919T00:00:00-20240926T19:30:00.log.zip",
- "4c0d3cf3-67f1-5ccb-0544-d58310840939/storage_access_20240926T00:00:00-20240930T20:40:00.log.zip"
]
}, - "type": "string",
- "updated": "2019-05-14T06:00:00"
}
}Get existing logs export task
Returns existing log export task by its ID.
Authorizations:
iam_token_project_scoped
path Parameters
| task_id required | string Task ID |
Responses
/v2/logs/{task_id}
Response samples
- 200
- 400
- 401
- 403
- 422
- default
Content type
application/json
{- "task": {
- "created": "2019-05-14T06:00:00",
- "data": {
- "container": "target_container",
- "delete_after": 3600,
- "fields": [
- "string"
], - "filters": {
- "property1": null,
- "property2": null
}, - "provider": "storage_access",
- "since": "2019-05-14T06:00:00",
- "till": "2019-05-14T06:00:00"
}, - "finished": "2019-05-14T06:00:00",
- "id": "string",
- "response": {
- "objects": [
- "3c9d2cf2-56f0-4ccb-9433-d47209739828/storage_access_20240919T00:00:00-20240926T19:30:00.log.zip",
- "4c0d3cf3-67f1-5ccb-0544-d58310840939/storage_access_20240926T00:00:00-20240930T20:40:00.log.zip"
]
}, - "type": "string",
- "updated": "2019-05-14T06:00:00"
}
}Cancel log export task
Cancels existing log export task by its id.
Authorizations:
iam_token_project_scoped
Responses
/v2/logs/{task_id}/cancel
Response samples
- 200
- 400
- 401
- 403
- 422
- default
Content type
application/json
{- "task": {
- "created": "2019-05-14T06:00:00",
- "data": {
- "container": "target_container",
- "delete_after": 3600,
- "fields": [
- "string"
], - "filters": {
- "property1": null,
- "property2": null
}, - "provider": "storage_access",
- "since": "2019-05-14T06:00:00",
- "till": "2019-05-14T06:00:00"
}, - "finished": "2019-05-14T06:00:00",
- "id": "string",
- "response": {
- "objects": [
- "3c9d2cf2-56f0-4ccb-9433-d47209739828/storage_access_20240919T00:00:00-20240926T19:30:00.log.zip",
- "4c0d3cf3-67f1-5ccb-0544-d58310840939/storage_access_20240926T00:00:00-20240930T20:40:00.log.zip"
]
}, - "type": "string",
- "updated": "2019-05-14T06:00:00"
}
}