Object Storage API

Get all buckets

get

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Query parameters

pageintegerOptional

Page number of the results to fetch

page_sizeintegerOptional

Number of results per page

name_filterstringOptional

search query

refreshbooleanOptional

refresh

Default: false

Responses

200

Bucket successfully retrieved

application/json

totalItemsintegerOptional

Total number of items

totalPagesintegerOptional

Total number of pages

currentPageintegerOptional

Current page number

nextPageintegerOptional

Next page number, if available

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

get

/kos/v1/buckets

HTTPcURLJavaScriptPython

GET /kos/v1/buckets HTTP/1.1
x-account-id: YOUR_API_KEY
Accept: */*

{
  "totalItems": 0,
  "nextPage": 5,
  "totalPages": 6,
  "currentPage": 1,
  "items": [
    {
      "name": "name",
      "krnid": "krnid",
      "url": "url",
      "region": "region",
      "versioning": false,
      "anonymous_access": false,
      "tags": {
        "keySomething": "value1",
        "keyAnother": "value2"
      },
      "createdAt": "2000-01-23T04:56:07.000+00:00",
      "tier": "fast/slow"
    },
    {
      "name": "name",
      "krnid": "krnid",
      "url": "url",
      "region": "region",
      "versioning": false,
      "anonymous_access": false,
      "tags": {
        "keySomething": "value1",
        "keyAnother": "value2"
      },
      "createdAt": "2000-01-23T04:56:07.000+00:00",
      "tier": "fast/slow"
    }
  ]
}

Creates a new bucket

post

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Body

application/json

namestringOptional

descriptionstringOptional

versioningbooleanOptional

anonymous_accessbooleanOptional

Responses

201

Bucket successfully created

application/json

400

Bad request

application/json

401

Unauthorized

application/json

409

Conflict, bucket already exists

application/json

422

Unprocessable entity, validation error

application/json

500

Internal server error

application/json

503

Service unavailable

application/json

post

/kos/v1/buckets

HTTPcURLJavaScriptPython

POST /kos/v1/buckets HTTP/1.1
x-account-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 142

{
  "name": "name",
  "description": "description",
  "tags": {
    "keySomething": "value1",
    "keyAnother": "value2"
  },
  "versioning": false,
  "anonymous_access": false
}

{
  "createdAt": "2000-01-23T04:56:07.000+00:00",
  "krn": "krn",
  "bucketName": "bucket-name"
}

Retrieves bucket information

get

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Path parameters

bucketIdstringRequired

ID of the bucket to retrieve

Responses

200

Bucket information retrieved successfully

application/json

namestring · nullableOptional

krnidstring · nullableOptional

ownerstringOptional

account_idstringOptional

createdAtstring · date-time · nullableOptional

usedCapacitynumber · double · nullableOptional

allocatedCapacityinteger · int64 · nullableOptional

regionstring · nullableOptional

urlstring · nullableOptional

statusstring · nullableOptional

pathstring · nullableOptional

protocolstring · nullableOptional

versioningboolean · nullableOptional

anonymous_accessboolean · nullableOptional

tierstring · nullableOptional

400

Bad request

application/json

401

Unauthorized

application/json

404

Bucket not found

application/json

500

Internal server error

application/json

503

Service unavailable

application/json

get

/kos/v1/buckets/{bucketId}

HTTPcURLJavaScriptPython

GET /kos/v1/buckets/{bucketId} HTTP/1.1
x-account-id: YOUR_API_KEY
Accept: */*

{
  "name": "bucket-name",
  "krnid": "krn-id-example",
  "createdAt": "2000-01-23T04:56:07.000+00:00",
  "tags": {
    "keySomething": "value1",
    "keyAnother": "value2"
  },
  "versioning": false,
  "anonymous_access": false,
  "region": "region",
  "owner": "d55a4dfd-9d8a-408c-9217-49dad340d02f",
  "tier": "fast/slow"
}

Updates bucket tags

put

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Path parameters

bucketIdstringRequired

ID of the bucket to update

Body

application/json

versioningbooleanOptional

anonymous_accessbooleanOptional

Responses

200

Bucket tags successfully updated

application/json

namestring · nullableOptional

krnidstring · nullableOptional

ownerstringOptional

account_idstringOptional

createdAtstring · date-time · nullableOptional

usedCapacitynumber · double · nullableOptional

allocatedCapacityinteger · int64 · nullableOptional

regionstring · nullableOptional

urlstring · nullableOptional

statusstring · nullableOptional

pathstring · nullableOptional

protocolstring · nullableOptional

versioningboolean · nullableOptional

anonymous_accessboolean · nullableOptional

tierstring · nullableOptional

400

Bad request

application/json

401

Unauthorized

application/json

404

Bucket not found

application/json

500

Internal server error

application/json

503

Service unavailable

application/json

put

/kos/v1/buckets/{bucketId}

HTTPcURLJavaScriptPython

PUT /kos/v1/buckets/{bucketId} HTTP/1.1
x-account-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 100

{
  "tags": {
    "keySomething": "value1",
    "keyAnother": "value2"
  },
  "versioning": false,
  "anonymous_access": false
}

{
  "name": "bucket-name",
  "krnid": "krn-id-example",
  "createdAt": "2000-01-23T04:56:07.000+00:00",
  "tags": {
    "keySomething": "value1",
    "keyAnother": "value2"
  },
  "versioning": false,
  "anonymous_access": false,
  "region": "region",
  "owner": "d55a4dfd-9d8a-408c-9217-49dad340d02f",
  "tier": "fast/slow"
}

Deletes a bucket

delete

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Path parameters

bucketIdstringRequired

ID of the bucket to delete

Body

application/json

otpstringOptional

Responses

204

Bucket successfully deleted, no content

400

Bad request

application/json

401

Unauthorized

application/json

404

Bucket not found

application/json

500

Internal server error

application/json

503

Service unavailable

application/json

delete

/kos/v1/buckets/{bucketId}

HTTPcURLJavaScriptPython

DELETE /kos/v1/buckets/{bucketId} HTTP/1.1
x-account-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "otp": "otp"
}

No content

Deletes all access keys

delete

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Responses

204

Access keys successfully deleted, no content

400

Bad request

application/json

401

Unauthorized

application/json

404

Access keys not found

application/json

500

Internal server error

application/json

503

Service unavailable

application/json

delete

/internal/kos/v1/access_keys_all

HTTPcURLJavaScriptPython

DELETE /internal/kos/v1/access_keys_all HTTP/1.1
x-account-id: YOUR_API_KEY
Accept: */*

No content

Retrieves a list of access keys

get

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Responses

200

Access keys successfully retrieved

application/json

access_keystringOptionalExample: access-key-1

created_datestring · date-timeOptionalExample: 2024-09-02T10:15:30Z

regionstringOptionalExample: us-west-2

400

Bad request

application/json

401

Unauthorized

application/json

404

Access key not found

application/json

500

Internal server error

application/json

503

Service unavailable

application/json

get

/kos/v1/access_keys

HTTPcURLJavaScriptPython

GET /kos/v1/access_keys HTTP/1.1
x-account-id: YOUR_API_KEY
Accept: */*

[
  {
    "access_key": "access-key-1",
    "created_date": "2024-09-02T10:15:30Z",
    "region": "us-west-2"
  },
  {
    "access_key": "access-key-2",
    "created_date": "2024-09-01T08:20:15Z",
    "region": "eu-central-1"
  }
]

Creates access keys

post

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Responses

201

Access keys successfully created

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

503

Service unavailable

application/json

post

/kos/v1/access_keys

HTTPcURLJavaScriptPython

POST /kos/v1/access_keys HTTP/1.1
x-account-id: YOUR_API_KEY
Accept: */*

{
  "access_key": "access-key-1",
  "secret_key": "secret-key-1"
}

Deletes an access key

delete

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Path parameters

accessKeystringRequired

ID of the access key to delete

Body

application/json

otpstringOptional

Responses

204

Access key successfully deleted, no content

400

Bad request

application/json

401

Unauthorized

application/json

404

Access key not found

application/json

500

Internal server error

application/json

503

Service unavailable

application/json

delete

/kos/v1/access_keys/{accessKey}

HTTPcURLJavaScriptPython

DELETE /kos/v1/access_keys/{accessKey} HTTP/1.1
x-account-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "otp": "otp"
}

No content

Get all lifecycle rules for a specific bucket

get

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Path parameters

bucketIdstringRequired

ID of the bucket to retrieve lifecycle rules for

Responses

200

Lifecycle rules successfully retrieved

application/json

namestringOptional

Name of the lifecycle rule

enabledboolean · nullableOptional

expiration_daysinteger · nullableOptional

expired_obj_delete_markerboolean · nullableOptional

noncurrent_daysinteger · nullableOptional

newer_noncurrent_versionsinteger · nullableOptional

delete_incomplete_mpuinteger · nullableOptional

attributestring · nullableOptional

Attribute used to calculate object age

idstringOptional

Unique ID of the lifecycle rule

statusstringOptional

Status of the lifecycle rule

400

Bad request

application/json

401

Unauthorized access

application/json

404

Bucket not found

application/json

500

Internal server error

application/json

503

Service unavailable

application/json

get

/kos/v1/buckets/{bucketId}/lifecycle-rules

HTTPcURLJavaScriptPython

GET /kos/v1/buckets/{bucketId}/lifecycle-rules HTTP/1.1
x-account-id: YOUR_API_KEY
Accept: */*

[
  {
    "delete_incomplete_mpu": 2,
    "name": "name",
    "attribute": "attribute",
    "enabled": true,
    "newer_noncurrent_versions": 5,
    "noncurrent_days": 5,
    "expiration_days": 1,
    "expired_obj_delete_marker": true,
    "id": "text",
    "status": "text"
  }
]

Create a new lifecycle rule for a specific bucket

post

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Path parameters

bucketIdstringRequired

ID of the bucket to which the lifecycle rule will be added

Body

application/json

namestringOptional

Name of the lifecycle rule

enabledboolean · nullableOptional

expiration_daysinteger · nullableOptional

expired_obj_delete_markerboolean · nullableOptional

noncurrent_daysinteger · nullableOptional

newer_noncurrent_versionsinteger · nullableOptional

delete_incomplete_mpuinteger · nullableOptional

attributestring · nullableOptional

Attribute used to calculate object age

Responses

201

Lifecycle rule successfully created

application/json

400

Bad request

application/json

401

Unauthorized access

application/json

404

Bucket not found

application/json

409

Conflict with existing resource

application/json

500

Internal server error

application/json

503

Service unavailable

application/json

post

/kos/v1/buckets/{bucketId}/lifecycle-rules

HTTPcURLJavaScriptPython

POST /kos/v1/buckets/{bucketId}/lifecycle-rules HTTP/1.1
x-account-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 183

{
  "delete_incomplete_mpu": 2,
  "name": "name",
  "attribute": "attribute",
  "enabled": true,
  "newer_noncurrent_versions": 5,
  "noncurrent_days": 5,
  "expiration_days": 1,
  "expired_obj_delete_marker": true
}

{
  "delete_incomplete_mpu": 2,
  "name": "name",
  "attribute": "attribute",
  "enabled": true,
  "newer_noncurrent_versions": 5,
  "noncurrent_days": 5,
  "status": "status",
  "expiration_days": 1,
  "id": "id",
  "expired_obj_delete_marker": true
}

Get a specific lifecycle rule for a bucket

get

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Path parameters

bucketIdstringRequired

ID of the bucket

ruleIdstringRequired

ID of the lifecycle rule to retrieve

Responses

200

Lifecycle rule retrieved successfully

application/json

namestringOptional

Name of the lifecycle rule

enabledboolean · nullableOptional

expiration_daysinteger · nullableOptional

expired_obj_delete_markerboolean · nullableOptional

noncurrent_daysinteger · nullableOptional

newer_noncurrent_versionsinteger · nullableOptional

delete_incomplete_mpuinteger · nullableOptional

attributestring · nullableOptional

Attribute used to calculate object age

idstringOptional

Unique ID of the lifecycle rule

statusstringOptional

Status of the lifecycle rule

400

Bad request

application/json

401

Unauthorized access

application/json

404

Bucket not found

application/json

500

Internal server error

application/json

503

Service unavailable

application/json

get

/kos/v1/buckets/{bucketId}/lifecycle-rules/{ruleId}

HTTPcURLJavaScriptPython

GET /kos/v1/buckets/{bucketId}/lifecycle-rules/{ruleId} HTTP/1.1
x-account-id: YOUR_API_KEY
Accept: */*

{
  "delete_incomplete_mpu": 2,
  "name": "name",
  "attribute": "attribute",
  "enabled": true,
  "newer_noncurrent_versions": 5,
  "noncurrent_days": 5,
  "status": "status",
  "expiration_days": 1,
  "id": "id",
  "expired_obj_delete_marker": true
}

Update a lifecycle rule for a bucket

put

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Path parameters

bucketIdstringRequired

ID of the bucket

ruleIdstringRequired

ID of the lifecycle rule to update

Body

application/json

namestringOptional

Name of the lifecycle rule

enabledboolean · nullableOptional

expiration_daysinteger · nullableOptional

expired_obj_delete_markerboolean · nullableOptional

noncurrent_daysinteger · nullableOptional

newer_noncurrent_versionsinteger · nullableOptional

delete_incomplete_mpuinteger · nullableOptional

attributestring · nullableOptional

Attribute used to calculate object age

Responses

200

Lifecycle rule successfully updated

application/json

namestringOptional

Name of the lifecycle rule

enabledboolean · nullableOptional

expiration_daysinteger · nullableOptional

expired_obj_delete_markerboolean · nullableOptional

noncurrent_daysinteger · nullableOptional

newer_noncurrent_versionsinteger · nullableOptional

delete_incomplete_mpuinteger · nullableOptional

attributestring · nullableOptional

Attribute used to calculate object age

idstringOptional

Unique ID of the lifecycle rule

statusstringOptional

Status of the lifecycle rule

400

Bad request

application/json

401

Unauthorized access

application/json

404

Bucket not found

application/json

500

Internal server error

application/json

503

Service unavailable

application/json

put

/kos/v1/buckets/{bucketId}/lifecycle-rules/{ruleId}

HTTPcURLJavaScriptPython

PUT /kos/v1/buckets/{bucketId}/lifecycle-rules/{ruleId} HTTP/1.1
x-account-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 183

{
  "delete_incomplete_mpu": 2,
  "name": "name",
  "attribute": "attribute",
  "enabled": true,
  "newer_noncurrent_versions": 5,
  "noncurrent_days": 5,
  "expiration_days": 1,
  "expired_obj_delete_marker": true
}

{
  "delete_incomplete_mpu": 2,
  "name": "name",
  "attribute": "attribute",
  "enabled": true,
  "newer_noncurrent_versions": 5,
  "noncurrent_days": 5,
  "status": "status",
  "expiration_days": 1,
  "id": "id",
  "expired_obj_delete_marker": true
}

Delete a lifecycle rule for a bucket

delete

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Path parameters

bucketIdstringRequired

ID of the bucket

ruleIdstringRequired

ID of the lifecycle rule to delete

Responses

204

Lifecycle rule successfully deleted

400

Bad request

application/json

401

Unauthorized access

application/json

404

Resource not found

application/json

500

Internal server error

application/json

503

Service unavailable

application/json

delete

/kos/v1/buckets/{bucketId}/lifecycle-rules/{ruleId}

HTTPcURLJavaScriptPython

DELETE /kos/v1/buckets/{bucketId}/lifecycle-rules/{ruleId} HTTP/1.1
x-account-id: YOUR_API_KEY
Accept: */*

No content

Retrieves a policy

get

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Responses

200

Policy successfully retrieved

application/json

namestringOptional

policy Name

policyKRNstringOptional

Unique ID of the policy

CreationDatestringOptional

Creation date of the policy

400

Bad request

application/json

401

Unauthorized

application/json

404

Policy not found

application/json

500

Internal server error

application/json

503

Service unavailable

application/json

get

/internal/kos/v1/policy

HTTPcURLJavaScriptPython

GET /internal/kos/v1/policy HTTP/1.1
x-account-id: YOUR_API_KEY
Accept: */*

{
  "name": "name",
  "policyKRN": "policyKRN",
  "CreationDate": "CreationDate"
}

Creates a policy

post

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Body

application/json

_idstringOptional

Unique ID of the policy

namestringOptional

Name of the policy

statementsobject[]Optional

Statements of the policy

conditionsobject[]Optional

Conditions of the policy

accountIdstringOptional

Account ID of the policy

policyKRNstringOptional

Unique ID of the policy

Responses

201

Policy successfully created

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

409

Policy already exists

application/json

422

Unprocessable entity, validation error

application/json

500

Internal server error

application/json

503

Service unavailable

application/json

post

/internal/kos/v1/policy

HTTPcURLJavaScriptPython

POST /internal/kos/v1/policy HTTP/1.1
x-account-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 128

{
  "_id": "_id",
  "name": "name",
  "statements": "statements",
  "conditions": "conditions",
  "accountId": "accountId",
  "policyKRN": "policyKRNs"
}

{
  "name": "name",
  "policyKRN": "policyKRN",
  "CreationDate": "CreationDate"
}

Attaches a policy to a bucket

post

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Body

application/json

policyKRNsstring[]Optional

Unique IDs of the policies

Responses

200

Policy successfully attached

application/json

namestringOptional

policy Name

policyKRNstringOptional

Unique ID of the policy

CreationDatestringOptional

Creation date of the policy

400

Invalid request

application/json

401

Unauthorized

application/json

404

Policy not found

application/json

500

Internal server error

application/json

503

Service unavailable

application/json

post

/internal/kos/v1/policy/attach

HTTPcURLJavaScriptPython

POST /internal/kos/v1/policy/attach HTTP/1.1
x-account-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "policyKRNs": [
    "policyKRN1",
    "policyKRN2"
  ]
}

{
  "name": "name",
  "policyKRN": "policyKRN",
  "CreationDate": "CreationDate"
}

Detaches a policy from a bucket

post

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Body

application/json

policyKRNsstring[]Optional

Unique IDs of the policies

Responses

200

Policy successfully detached

application/json

namestringOptional

policy Name

policyKRNstringOptional

Unique ID of the policy

CreationDatestringOptional

Creation date of the policy

400

Invalid request

application/json

401

Unauthorized

application/json

404

Policy not found

application/json

500

Internal server error

application/json

503

Service unavailable

application/json

post

/internal/kos/v1/policy/detach

HTTPcURLJavaScriptPython

POST /internal/kos/v1/policy/detach HTTP/1.1
x-account-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "kcid": "kcid123",
  "policyKRNs": [
    "policyKRN1",
    "policyKRN2"
  ]
}

{
  "name": "name",
  "policyKRN": "policyKRN",
  "CreationDate": "CreationDate"
}

Retrieves a policy

get

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Path parameters

policykrnstringRequired

ID of the policy

Responses

200

Policy successfully retrieved

application/json

namestringOptional

policy Name

policyKRNstringOptional

Unique ID of the policy

CreationDatestringOptional

Creation date of the policy

400

Bad request

application/json

401

Unauthorized

application/json

404

Policy not found

application/json

500

Internal server error

application/json

503

Service unavailable

application/json

get

/internal/kos/v1/policy/{policykrn}

HTTPcURLJavaScriptPython

GET /internal/kos/v1/policy/{policykrn} HTTP/1.1
x-account-id: YOUR_API_KEY
Accept: */*

{
  "name": "name",
  "policyKRN": "policyKRN",
  "CreationDate": "CreationDate"
}

Updates a policy

put

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Path parameters

policykrnstringRequired

ID of the policy

Body

application/json

_idstringOptional

Unique ID of the policy

namestringOptional

Name of the policy

statementsobject[]Optional

Statements of the policy

conditionsobject[]Optional

Conditions of the policy

accountIdstringOptional

Account ID of the policy

policyKRNstringOptional

Unique ID of the policy

Responses

200

Policy successfully updated

application/json

namestringOptional

policy Name

policyKRNstringOptional

Unique ID of the policy

CreationDatestringOptional

Creation date of the policy

400

Bad request

application/json

401

Unauthorized

application/json

404

Policy not found

application/json

500

Internal server error

application/json

503

Service unavailable

application/json

put

/internal/kos/v1/policy/{policykrn}

HTTPcURLJavaScriptPython

PUT /internal/kos/v1/policy/{policykrn} HTTP/1.1
x-account-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 128

{
  "_id": "_id",
  "name": "name",
  "statements": "statements",
  "conditions": "conditions",
  "accountId": "accountId",
  "policyKRN": "policyKRNs"
}

{
  "name": "name",
  "policyKRN": "policyKRN",
  "CreationDate": "CreationDate"
}

Deletes a policy

delete

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Path parameters

policykrnstringRequired

ID of the policy

Responses

204

Policy successfully deleted

400

Bad request

application/json

401

Unauthorized

application/json

404

Policy not found

application/json

500

Internal server error

application/json

503

Service unavailable

application/json

delete

/internal/kos/v1/policy/{policykrn}

HTTPcURLJavaScriptPython

DELETE /internal/kos/v1/policy/{policykrn} HTTP/1.1
x-account-id: YOUR_API_KEY
Accept: */*

No content

Activate a new session for API access

post

Creates a new session for accessing protected APIs.

• If a previous session exists and is still active, it will be invalidated

• Sessions automatically expire after the configured timeout

• Only one active session is allowed per set of credentials

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Body

application/json

accessKeystringRequired

Access key for authentication

secretKeystringRequired

Secret key for authentication

Responses

200

Session activated successfully

application/json

sessionTokenstringOptional

Session token to be used for protected APIs

expiresAtstring · date-timeOptional

Session expiration timestamp

refreshTokenstringOptional

Token used to refresh the session before expiration

lastActiveAtstring · date-timeOptional

Timestamp of last activity

400

Invalid credentials or request format

application/json

401

Unauthorized - Invalid credentials

429

Too many session activation attempts

application/json

500

Internal server error

application/json

post

/kos/v1/sessions/activate

HTTPcURLJavaScriptPython

POST /kos/v1/sessions/activate HTTP/1.1
x-account-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "accessKey": "text",
  "secretKey": "text"
}

{
  "lastActiveAt": "2000-01-23T04:56:07.000+00:00",
  "sessionToken": "sessionToken",
  "expiresAt": "2000-01-23T04:56:07.000+00:00",
  "refreshToken": "refreshToken"
}

Deactivate current session

delete

Explicitly deactivates the current session.

• Invalidates the session token

• Blocks access to protected APIs

• Cleans up session resources

Authorizations

SessionToken

Path parameters

sessionTokenstringRequired

Session token

Responses

204

Session deactivated successfully

401

Invalid session token

404

Session not found

500

Internal server error

application/json

delete

/kos/v1/sessions/deactivate/{sessionToken}

HTTPcURLJavaScriptPython

DELETE /kos/v1/sessions/deactivate/{sessionToken} HTTP/1.1
Accept: */*

No content

Refresh current session

post

Extends the current session lifetime before it expires

Authorizations

SessionToken

Path parameters

sessionTokenstringRequired

Session token

Body

application/json

refreshTokenstringRequired

Responses

200

Session refreshed successfully

application/json

sessionTokenstringOptional

expiresAtstring · date-timeOptional

refreshTokenstringOptional

401

Invalid refresh token or session

404

Session not found

500

Internal server error

application/json

post

/kos/v1/sessions/refresh/{sessionToken}

HTTPcURLJavaScriptPython

POST /kos/v1/sessions/refresh/{sessionToken} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "refreshToken": "text"
}

{
  "sessionToken": "sessionToken",
  "expiresAt": "2000-01-23T04:56:07.000+00:00",
  "refreshToken": "refreshToken"
}

Get current session status

get

Returns the status and details of the current session

Authorizations

SessionToken

Path parameters

sessionTokenstringRequired

Responses

200

Session status retrieved successfully

application/json

isActivebooleanOptional

expiresAtstring · date-timeOptional

lastActiveAtstring · date-timeOptional

createdAtstring · date-timeOptional

401

Invalid or expired session token

404

Session not found

500

Internal server error

application/json

get

/kos/v1/sessions/status/{sessionToken}

HTTPcURLJavaScriptPython

GET /kos/v1/sessions/status/{sessionToken} HTTP/1.1
Accept: */*

{
  "lastActiveAt": "2000-01-23T04:56:07.000+00:00",
  "createdAt": "2000-01-23T04:56:07.000+00:00",
  "isActive": true,
  "expiresAt": "2000-01-23T04:56:07.000+00:00"
}

Delete an object

post

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Path parameters

bucketIdstringRequired

Krn identifier of the bucket

Body

application/json

objectkeystringOptional

The key of the object to delete

Responses

200

File deleted successfully

application/json

messagestringOptional

objectKeystringOptional

The key of the deleted file

400

Bad request, invalid parameters

application/json

401

Unauthorized, invalid credentials

application/json

404

Object not found or bucket does not exist

application/json

500

Internal server error

application/json

post

/kos/v1/buckets/{bucketId}/objects/delete

HTTPcURLJavaScriptPython

POST /kos/v1/buckets/{bucketId}/objects/delete HTTP/1.1
x-account-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "objectkey": "text"
}

{
  "objectKey": "objectKey",
  "message": "message"
}

List objects in a bucket

get

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Path parameters

bucketIdstringRequired

Krn identifier of the bucket

Query parameters

prefixstringOptional

Filter objects by prefix (like a folder path)

Responses

200

List of objects in the bucket

application/json

prefixstringOptional

The folder path prefix for objects

400

Bad request, invalid parameters

application/json

401

Unauthorized, invalid credentials

application/json

404

Bucket not found

application/json

500

Internal server error

application/json

get

/kos/v1/buckets/{bucketId}/objects

HTTPcURLJavaScriptPython

GET /kos/v1/buckets/{bucketId}/objects HTTP/1.1
x-account-id: YOUR_API_KEY
Accept: */*

{
  "prefix": "prefix",
  "objects": [
    {
      "isFolder": true,
      "size": 0,
      "lastModified": "2000-01-23T04:56:07.000+00:00",
      "key": "key"
    },
    {
      "isFolder": true,
      "size": 0,
      "lastModified": "2000-01-23T04:56:07.000+00:00",
      "key": "key"
    }
  ]
}

Upload a new object

put

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Path parameters

bucketIdstringRequired

Krn identifier of the bucket

Body

application/json

prefixstringOptional

The folder path prefix for objects

Responses

201

File uploaded successfully

application/json

400

Bad request, invalid parameters

application/json

401

Unauthorized, invalid credentials

application/json

404

Bucket not found

application/json

500

Internal server error

application/json

put

/kos/v1/buckets/{bucketId}/objects

HTTPcURLJavaScriptPython

PUT /kos/v1/buckets/{bucketId}/objects HTTP/1.1
x-account-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "prefix": "prefix"
}

{
  "objectKey": "objectKey",
  "message": "message"
}

Download an object

post

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Path parameters

bucketIdstringRequired

Krn identifier of the bucket

Body

application/json

objectkeystringOptional

The key of the object to download

Responses

200

The file content as binary

application/octet-stream

messagestringOptional

objectKeystringOptional

The key and preSignedUrl of the download file

400

Bad request, invalid parameters

application/json

401

Unauthorized, invalid credentials

application/json

404

Object not found or bucket does not exist

application/json

500

Internal server error

application/json

post

/kos/v1/buckets/{bucketId}/objects/download

HTTPcURLJavaScriptPython

POST /kos/v1/buckets/{bucketId}/objects/download HTTP/1.1
x-account-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "objectkey": "text"
}

{
  "objectKey": "objectKey",
  "preSignedUrl": "downloadPreSignedUrl"
}

Get object metadata

post

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Path parameters

bucketIdstringRequired

Krn identifier of the bucket

Body

application/json

objectkeystringOptional

The key of the object to download

Responses

200

Metadata of the object

application/json

keystringRequired

Object key (path within bucket)

size_bytesinteger · int64Required

Object size in bytes

storage_classstringOptional

Storage class of the object

lastModifiedstringRequired

Last modified date

contentTypestringOptional

MIME type of the object

etagstringOptional

ETag of the object

400

Bad request, invalid parameters

application/json

401

Unauthorized, invalid credentials

application/json

404

Object not found or bucket does not exist

application/json

500

Internal server error

application/json

post

/kos/v1/buckets/{bucketId}/objects/metadata

HTTPcURLJavaScriptPython

POST /kos/v1/buckets/{bucketId}/objects/metadata HTTP/1.1
x-account-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "objectkey": "text"
}

{
  "size_bytes": 0,
  "storage_class": "storage_class",
  "etag": "etag",
  "lastModified": "2000-01-23T04:56:07.000+00:00",
  "contentType": "contentType",
  "key": "key"
}

Move or copy an object within a bucket

post

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Path parameters

bucketIdstringRequired

Krn identifier of the bucket

Body

application/json

sourceKeystringOptional

Source object key

destinationKeystringOptional

Destination object key

actionstring · enumOptional

Action to perform (move or copy)

Possible values:

Responses

200

File moved or copied successfully

application/json

messagestringOptional

sourceKeystringOptional

Source key

destinationKeystringOptional

Destination key

post

/kos/v1/buckets/{bucketId}/objects/move

HTTPcURLJavaScriptPython

POST /kos/v1/buckets/{bucketId}/objects/move HTTP/1.1
x-account-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "sourceKey": "text",
  "destinationKey": "text",
  "action": "move"
}

200

File moved or copied successfully

{
  "sourceKey": "sourceKey",
  "destinationKey": "destinationKey",
  "message": "message"
}

Rename an object within the bucket

post

Rename an object by copying it to a new key and deleting the original.

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Path parameters

bucketIdstringRequired

Krn identifier of the bucket

Body

application/json

oldKeystringOptional

The old key for the object (the old name/path for the file)

newKeystringOptional

The new key for the object (the new name/path for the file)

Responses

200

Object renamed successfully

application/json

messagestringOptionalExample: Object renamed successfully

oldKeystringOptional

Original key of the object

newKeystringOptional

New key of the object

400

Invalid request parameters

404

Object not found

post

/kos/v1/buckets/{bucketId}/objects/rename

HTTPcURLJavaScriptPython

POST /kos/v1/buckets/{bucketId}/objects/rename HTTP/1.1
x-account-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "oldKey": "text",
  "newKey": "text"
}

{
  "oldKey": "oldKey",
  "newKey": "newKey",
  "message": "Object renamed successfully"
}

Get Bucket Policy Details

get

Returns details of a specified bucket policy.

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Path parameters

bucketKrnstringRequired

The unique bucketKrn (Key Resource Name) of the bucket policy.

Responses

200

Details of the bucket policy.

application/json

bucketPolicyKrnstringOptional

Unique Key Resource Name (KRN) of the bucket policy.

bucketKrnstringOptional

Unique Key Resource Name (KRN) of the bucket policy.

s3_read_write_ipsstring[]Optional

S3 hosts with read/write permissions.

s3_read_only_ipsstring[]Optional

S3 hosts with read-only permissions.

created_atstring · date-timeOptional

Creation timestamp of the policy.

updated_atstring · date-timeOptional

Last updated timestamp of the policy.

400

Bad request, invalid parameters

application/json

401

Unauthorized access

application/json

500

Internal server error

application/json

503

Service unavailable

application/json

get

/kos/v1/buckets/policy/{bucketKrn}

HTTPcURLJavaScriptPython

GET /kos/v1/buckets/policy/{bucketKrn} HTTP/1.1
x-account-id: YOUR_API_KEY
Accept: */*

{
  "updated_at": "2000-01-23T04:56:07.000+00:00",
  "created_at": "2000-01-23T04:56:07.000+00:00",
  "s3_read_write_ips": [
    "s3_read_write_ips",
    "s3_read_write_ips"
  ],
  "s3_read_only_ips": [
    "s3_read_only_ips",
    "s3_read_only_ips"
  ],
  "bucketKrn": "bucketKrn",
  "bucketPolicyKrn": "bucketPolicyKrn"
}

Create a Bucket Policy

post

Creates a new bucket policy.

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Path parameters

bucketKrnstringRequired

The unique bucketKrn of the bucket policy to create.

Body

application/json

s3_read_write_ipsstring[]Optional

S3 hosts with read/write permissions.

s3_read_only_ipsstring[]Optional

S3 hosts with read-only permissions.

Responses

201

Bucket policy created.

application/json

400

Bad request, invalid parameters

application/json

401

Unauthorized access

application/json

404

Bucket not found

application/json

500

Internal server error

application/json

503

Service unavailable

application/json

post

/kos/v1/buckets/policy/{bucketKrn}

HTTPcURLJavaScriptPython

POST /kos/v1/buckets/policy/{bucketKrn} HTTP/1.1
x-account-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 122

{
  "s3_read_write_ips": [
    "s3_read_write_ips",
    "s3_read_write_ips"
  ],
  "s3_read_only_ips": [
    "s3_read_only_ips",
    "s3_read_only_ips"
  ]
}

{
  "updated_at": "2000-01-23T04:56:07.000+00:00",
  "created_at": "2000-01-23T04:56:07.000+00:00",
  "s3_read_write_ips": [
    "s3_read_write_ips",
    "s3_read_write_ips"
  ],
  "s3_read_only_ips": [
    "s3_read_only_ips",
    "s3_read_only_ips"
  ],
  "bucketKrn": "bucketKrn",
  "bucketPolicyKrn": "bucketPolicyKrn"
}

Modify a Bucket Policy

put

Modifies an existing bucket policy.

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Path parameters

bucketKrnstringRequired

The unique bucketKrn of the bucket policy.

Body

application/json

s3_read_write_ipsstring[]Optional

S3 hosts with read/write permissions.

s3_read_only_ipsstring[]Optional

S3 hosts with read-only permissions.

Responses

200

Bucket policy modified.

No content

400

Bad request, invalid parameters

application/json

401

Unauthorized access

application/json

404

Bucket policy not found

application/json

500

Internal server error

application/json

503

Service unavailable

application/json

put

/kos/v1/buckets/policy/{bucketKrn}

HTTPcURLJavaScriptPython

PUT /kos/v1/buckets/policy/{bucketKrn} HTTP/1.1
x-account-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 122

{
  "s3_read_write_ips": [
    "s3_read_write_ips",
    "s3_read_write_ips"
  ],
  "s3_read_only_ips": [
    "s3_read_only_ips",
    "s3_read_only_ips"
  ]
}

No content

Delete a Bucket Policy

delete

Deletes a specified bucket policy.

Authorizations

x-account-idK-Customer-IDx-userx-user-emailx-region-idAuthorizationx-tierx-session-token

x-account-idstringRequired

account id

Path parameters

bucketKrnstringRequired

The unique bucketKrn of the bucket policy to delete.

Responses

204

Bucket policy deleted.

400

Bad request, invalid parameters

application/json

401

Unauthorized access

application/json

404

Bucket policy not found

application/json

500

Internal server error

application/json

503

Service unavailable

application/json

delete

/kos/v1/buckets/policy/{bucketKrn}

HTTPcURLJavaScriptPython

DELETE /kos/v1/buckets/policy/{bucketKrn} HTTP/1.1
x-account-id: YOUR_API_KEY
Accept: */*

No content