Перейти к основному содержимому
API docs by Redocly

Object Storage API (v2.1.0)

Managing account information, container options and domains, creating log exports, and more.

Account

Get account information and container statistics

Returns general account information and containers statistics.

Authorizations:
iam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "bytes_used": 123321,
  • "containers_count": 123321,
  • "object_count": 123321,
  • "quota_bytes": 123321,
  • "status": "string",
  • "storage_policies_stats": {
    }
}

Get account quota information

Return account quota of bytes.

Authorizations:
iam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "quota_bytes": 123321
}

Set up account quotas

Sets up account quotas of bytes.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required

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

Request samples

Content type
application/json
{
  • "quota_bytes": 1024
}

Response samples

Content type
application/json
{
  • "quota_bytes": 123321
}

Containers

Delete container domains

Deletes specified domains bound to container.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required

Container Domains

domains
Array of strings

Responses

Request samples

Content type
application/json
{
  • "domains": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "error description"
}

Get list of container domains

Retrieves domains bound to container.

Authorizations:
iam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "domains": [
    ]
}

Add a domain to container

Adds specified domain to container.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required

Container Domains

domain_name
string

Responses

Request samples

Content type
application/json
{
  • "domain_name": "some.domain.com"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "error description"
}

Get list of container domains and certificates (legacy)

Retrieves domains and their certificates bound to container.

Authorizations:
iam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "domains": [
    ]
}

Get container options

Returns actual container options.

Authorizations:
iam_token_project_scoped
path Parameters
container_name
required
string

Container name

Responses

Response samples

Content type
application/json
{
  • "general": {
    },
  • "quota": {
    },
  • "web": {
    }
}

Set container options

Sets container options.

Authorizations:
iam_token_project_scoped
path Parameters
container_name
required
string

Container name

Request Body schema: application/json
required

Container options

object (ContainerGeneralOptionsBodySwagger)
object (ContainerQuotaOptionsBodySwagger)
object (ContainerWebOptionsBodySwagger)

Responses

Request samples

Content type
application/json
{
  • "general": {
    },
  • "quota": {
    },
  • "web": {
    }
}

Response samples

Content type
application/json
{
  • "general": {
    },
  • "quota": {
    },
  • "web": {
    }
}

List container domains with imported certificates

Retrieves domains associated with the container. Every domain is supplemented with the imported certificates covering it.

Authorizations:
iam_token_project_scoped
path Parameters
container_name
required
string

Container name.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Logs

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

Response samples

Content type
application/json
{
  • "tasks": [
    ]
}

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/json
required

Log task body

object
type
string

Responses

Request samples

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

Response samples

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

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

Response samples

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

Cancel log export task

Cancels existing log export task by its id.

Authorizations:
iam_token_project_scoped

Responses

Response samples

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

SSL Certificates

Get list of SSL certificates

Returns list of SSL certificates.

Authorizations:
iam_token_project_scoped

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Upload SSL certificate

Uploads a new SSL certificate and queues it for validation.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required

Certificate body

certificate
string
name
string
private_key
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "badge_status": "pending",
  • "created_at": "2019-05-14T06:00:00",
  • "domains": [
    ],
  • "error_message": "error_message",
  • "expire_in_days": 365,
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "name": "90486_cert",
  • "not_after": "2019-05-14T06:00:00"
}

Delete SSL certificate

Deletes an SSL certificate.

Authorizations:
iam_token_project_scoped
path Parameters
certificate_id
required
string

Certificate ID (UUID)

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "error description"
}

Get SSL certificate

Returns an SSL certificate.

Authorizations:
iam_token_project_scoped
path Parameters
certificate_id
required
string

Certificate ID (UUID)

Responses

Response samples

Content type
application/json
{
  • "badge_status": "pending",
  • "created_at": "2019-05-14T06:00:00",
  • "domains": [
    ],
  • "error_message": "error_message",
  • "expire_in_days": 365,
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "name": "90486_cert",
  • "not_after": "2019-05-14T06:00:00"
}

Delete SSL certificate

Deletes an imported SSL certificate.

Authorizations:
iam_token_project_scoped
path Parameters
certificate_id
required
string

Certificate ID

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "error description"
}

Import SSL certificate

Imports an existing SSL certificate from Certificates Manager.

Authorizations:
iam_token_project_scoped
path Parameters
certificate_id
required
string

Certificate ID in Certificates Manager.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "error description"
}