Object Storage API
Page number of the results to fetch
Number of results per page
search query
refresh
falseBucket successfully retrieved
Bad request
Unauthorized
Internal server error
GET /kos/v1/buckets HTTP/1.1
Host: /
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"
}
]
}Bucket successfully created
Bad request
Unauthorized
Conflict, bucket already exists
Unprocessable entity, validation error
Internal server error
Service unavailable
POST /kos/v1/buckets HTTP/1.1
Host: /
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"
}ID of the bucket to retrieve
Bucket information retrieved successfully
Bad request
Unauthorized
Bucket not found
Internal server error
Service unavailable
GET /kos/v1/buckets/{bucketId} HTTP/1.1
Host: /
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"
}ID of the bucket to update
Bucket tags successfully updated
Bad request
Unauthorized
Bucket not found
Internal server error
Service unavailable
PUT /kos/v1/buckets/{bucketId} HTTP/1.1
Host: /
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"
}ID of the bucket to delete
Bucket successfully deleted, no content
No content
Bad request
Unauthorized
Bucket not found
Internal server error
Service unavailable
DELETE /kos/v1/buckets/{bucketId} HTTP/1.1
Host: /
x-account-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 13
{
"otp": "otp"
}No content
Access keys successfully deleted, no content
No content
Bad request
Unauthorized
Access keys not found
Internal server error
Service unavailable
DELETE /internal/kos/v1/access_keys_all HTTP/1.1
Host: /
x-account-id: YOUR_API_KEY
Accept: */*
No content
Access keys successfully retrieved
Bad request
Unauthorized
Access key not found
Internal server error
Service unavailable
GET /kos/v1/access_keys HTTP/1.1
Host: /
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"
}
]Access keys successfully created
Bad request
Unauthorized
Internal server error
Service unavailable
POST /kos/v1/access_keys HTTP/1.1
Host: /
x-account-id: YOUR_API_KEY
Accept: */*
{
"access_key": "access-key-1",
"secret_key": "secret-key-1"
}ID of the access key to delete
Access key successfully deleted, no content
No content
Bad request
Unauthorized
Access key not found
Internal server error
Service unavailable
DELETE /kos/v1/access_keys/{accessKey} HTTP/1.1
Host: /
x-account-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 13
{
"otp": "otp"
}No content
ID of the bucket to retrieve lifecycle rules for
Lifecycle rules successfully retrieved
Bad request
Unauthorized access
Bucket not found
Internal server error
Service unavailable
GET /kos/v1/buckets/{bucketId}/lifecycle-rules HTTP/1.1
Host: /
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"
}
]ID of the bucket to which the lifecycle rule will be added
Name of the lifecycle rule
Attribute used to calculate object age
Lifecycle rule successfully created
{"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}Bad request
Unauthorized access
Bucket not found
Conflict with existing resource
Internal server error
Service unavailable
POST /kos/v1/buckets/{bucketId}/lifecycle-rules HTTP/1.1
Host: /
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
}ID of the bucket
ID of the lifecycle rule to retrieve
Lifecycle rule retrieved successfully
{"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}Bad request
Unauthorized access
Bucket not found
Internal server error
Service unavailable
GET /kos/v1/buckets/{bucketId}/lifecycle-rules/{ruleId} HTTP/1.1
Host: /
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
}ID of the bucket
ID of the lifecycle rule to update
Name of the lifecycle rule
Attribute used to calculate object age
Lifecycle rule successfully updated
{"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}Bad request
Unauthorized access
Bucket not found
Internal server error
Service unavailable
PUT /kos/v1/buckets/{bucketId}/lifecycle-rules/{ruleId} HTTP/1.1
Host: /
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
}ID of the bucket
ID of the lifecycle rule to delete
Lifecycle rule successfully deleted
No content
Bad request
Unauthorized access
Resource not found
Internal server error
Service unavailable
DELETE /kos/v1/buckets/{bucketId}/lifecycle-rules/{ruleId} HTTP/1.1
Host: /
x-account-id: YOUR_API_KEY
Accept: */*
No content
Policy successfully retrieved
{"name":"name","policyKRN":"policyKRN","CreationDate":"CreationDate"}Bad request
Unauthorized
Policy not found
Internal server error
Service unavailable
GET /internal/kos/v1/policy HTTP/1.1
Host: /
x-account-id: YOUR_API_KEY
Accept: */*
{
"name": "name",
"policyKRN": "policyKRN",
"CreationDate": "CreationDate"
}Unique ID of the policy
Name of the policy
Statements of the policy
Conditions of the policy
Account ID of the policy
Unique ID of the policy
Policy successfully created
{"name":"name","policyKRN":"policyKRN","CreationDate":"CreationDate"}Invalid request
Unauthorized
Policy already exists
Unprocessable entity, validation error
Internal server error
Service unavailable
POST /internal/kos/v1/policy HTTP/1.1
Host: /
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"
}Unique IDs of the policies
Policy successfully attached
{"name":"name","policyKRN":"policyKRN","CreationDate":"CreationDate"}Invalid request
Unauthorized
Policy not found
Internal server error
Service unavailable
POST /internal/kos/v1/policy/attach HTTP/1.1
Host: /
x-account-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 42
{
"policyKRNs": [
"policyKRN1",
"policyKRN2"
]
}{
"name": "name",
"policyKRN": "policyKRN",
"CreationDate": "CreationDate"
}Unique IDs of the policies
Policy successfully detached
{"name":"name","policyKRN":"policyKRN","CreationDate":"CreationDate"}Invalid request
Unauthorized
Policy not found
Internal server error
Service unavailable
POST /internal/kos/v1/policy/detach HTTP/1.1
Host: /
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"
}ID of the policy
Policy successfully retrieved
{"name":"name","policyKRN":"policyKRN","CreationDate":"CreationDate"}Bad request
Unauthorized
Policy not found
Internal server error
Service unavailable
GET /internal/kos/v1/policy/{policykrn} HTTP/1.1
Host: /
x-account-id: YOUR_API_KEY
Accept: */*
{
"name": "name",
"policyKRN": "policyKRN",
"CreationDate": "CreationDate"
}ID of the policy
Unique ID of the policy
Name of the policy
Statements of the policy
Conditions of the policy
Account ID of the policy
Unique ID of the policy
Policy successfully updated
{"name":"name","policyKRN":"policyKRN","CreationDate":"CreationDate"}Bad request
Unauthorized
Policy not found
Internal server error
Service unavailable
PUT /internal/kos/v1/policy/{policykrn} HTTP/1.1
Host: /
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"
}ID of the policy
Policy successfully deleted
No content
Bad request
Unauthorized
Policy not found
Internal server error
Service unavailable
DELETE /internal/kos/v1/policy/{policykrn} HTTP/1.1
Host: /
x-account-id: YOUR_API_KEY
Accept: */*
No content
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
Access key for authentication
Secret key for authentication
Session activated successfully
Invalid credentials or request format
Unauthorized - Invalid credentials
Too many session activation attempts
Internal server error
POST /kos/v1/sessions/activate HTTP/1.1
Host: /
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"
}Explicitly deactivates the current session.
Invalidates the session token
Blocks access to protected APIs
Cleans up session resources
Session token
Session deactivated successfully
No content
Invalid session token
Session not found
Internal server error
DELETE /kos/v1/sessions/deactivate/{sessionToken} HTTP/1.1
Host: /
Accept: */*
No content
Extends the current session lifetime before it expires
Session token
Session refreshed successfully
Invalid refresh token or session
Session not found
Internal server error
POST /kos/v1/sessions/refresh/{sessionToken} HTTP/1.1
Host: /
Content-Type: application/json
Accept: */*
Content-Length: 23
{
"refreshToken": "text"
}{
"sessionToken": "sessionToken",
"expiresAt": "2000-01-23T04:56:07.000+00:00",
"refreshToken": "refreshToken"
}Returns the status and details of the current session
Session status retrieved successfully
Invalid or expired session token
Session not found
Internal server error
GET /kos/v1/sessions/status/{sessionToken} HTTP/1.1
Host: /
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"
}Krn identifier of the bucket
The key of the object to delete
File deleted successfully
Bad request, invalid parameters
Unauthorized, invalid credentials
Object not found or bucket does not exist
Internal server error
POST /kos/v1/buckets/{bucketId}/objects/delete HTTP/1.1
Host: /
x-account-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 20
{
"objectkey": "text"
}{
"objectKey": "objectKey",
"message": "message"
}Krn identifier of the bucket
Filter objects by prefix (like a folder path)
List of objects in the bucket
Bad request, invalid parameters
Unauthorized, invalid credentials
Bucket not found
Internal server error
GET /kos/v1/buckets/{bucketId}/objects HTTP/1.1
Host: /
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"
}
]
}Krn identifier of the bucket
The folder path prefix for objects
File uploaded successfully
Bad request, invalid parameters
Unauthorized, invalid credentials
Bucket not found
Internal server error
PUT /kos/v1/buckets/{bucketId}/objects HTTP/1.1
Host: /
x-account-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"prefix": "prefix"
}{
"objectKey": "objectKey",
"message": "message"
}Krn identifier of the bucket
The key of the object to download
The file content as binary
Bad request, invalid parameters
Unauthorized, invalid credentials
Object not found or bucket does not exist
Internal server error
POST /kos/v1/buckets/{bucketId}/objects/download HTTP/1.1
Host: /
x-account-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 20
{
"objectkey": "text"
}{
"objectKey": "objectKey",
"preSignedUrl": "downloadPreSignedUrl"
}Krn identifier of the bucket
The key of the object to download
Metadata of the object
Bad request, invalid parameters
Unauthorized, invalid credentials
Object not found or bucket does not exist
Internal server error
POST /kos/v1/buckets/{bucketId}/objects/metadata HTTP/1.1
Host: /
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"
}Krn identifier of the bucket
Source object key
Destination object key
Action to perform (move or copy)
File moved or copied successfully
POST /kos/v1/buckets/{bucketId}/objects/move HTTP/1.1
Host: /
x-account-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 60
{
"sourceKey": "text",
"destinationKey": "text",
"action": "move"
}File moved or copied successfully
{
"sourceKey": "sourceKey",
"destinationKey": "destinationKey",
"message": "message"
}Rename an object by copying it to a new key and deleting the original.
Krn identifier of the bucket
The old key for the object (the old name/path for the file)
The new key for the object (the new name/path for the file)
Object renamed successfully
Invalid request parameters
Object not found
POST /kos/v1/buckets/{bucketId}/objects/rename HTTP/1.1
Host: /
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"
}Returns details of a specified bucket policy.
The unique bucketKrn (Key Resource Name) of the bucket policy.
Details of the bucket policy.
Bad request, invalid parameters
Unauthorized access
Internal server error
Service unavailable
GET /kos/v1/buckets/policy/{bucketKrn} HTTP/1.1
Host: /
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"
}Creates a new bucket policy.
The unique bucketKrn of the bucket policy to create.
S3 hosts with read/write permissions.
S3 hosts with read-only permissions.
Bucket policy created.
Bad request, invalid parameters
Unauthorized access
Bucket not found
Internal server error
Service unavailable
POST /kos/v1/buckets/policy/{bucketKrn} HTTP/1.1
Host: /
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"
}Modifies an existing bucket policy.
The unique bucketKrn of the bucket policy.
S3 hosts with read/write permissions.
S3 hosts with read-only permissions.
Bucket policy modified.
No content
Bad request, invalid parameters
Unauthorized access
Bucket policy not found
Internal server error
Service unavailable
PUT /kos/v1/buckets/policy/{bucketKrn} HTTP/1.1
Host: /
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
Deletes a specified bucket policy.
The unique bucketKrn of the bucket policy to delete.
Bucket policy deleted.
No content
Bad request, invalid parameters
Unauthorized access
Bucket policy not found
Internal server error
Service unavailable
DELETE /kos/v1/buckets/policy/{bucketKrn} HTTP/1.1
Host: /
x-account-id: YOUR_API_KEY
Accept: */*
No content
Last updated
Was this helpful?