Object Store v2 API

1.0.0

Overview

Statistics
19 Operations
0 Skills
Storage Category
Manage object stores, partitions, and key-value entries across environments and regions in Object Store v2.

Servers

  • https://object-store-us-east-1.anypoint.mulesoft.com/api/v1

Authentication & Security

  • bearerAuth http

    Bearer token authentication. Login endpoint: https://anypoint.mulesoft.com/accounts/api/login

  • clientAuth oauth2

    OAuth2 client credentials. Token endpoint: https://anypoint.mulesoft.com/accounts/api/v2/oauth2/token

List object stores listStores

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Get list of object stores in the given environment. If you are using connected app, either of "View Stores / Manage Stores / Manage Store Data" scopes are needed. Note that this API only returns the list of stores that currently exist. To retrieve a list of stores for a given timeframe (including stores that don't exist anymore), use the Object Store V2 Stats APIs.

Path Parameters

organizationId *: string
environmentId *: string

Query Parameters

nextPageToken: string
pageSize: integer

Response

List of stores
Examples
application/json
{ "values": [ { "storeId": "testStoreId", "encrypted": "false", "defaultTtlMillis": 120000, "defaultConfirmationTtlMillis": 10000 }, { "storeId": "otherTestStoreId", "encrypted": "false", "defaultTtlMillis": 120000, "defaultConfirmationTtlMillis": 10000 } ], "nextPageToken": "otherTestStoreId" }

Get object store getStore

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Get object store details. If you are using connected app, either of "View Stores / Manage Stores / Manage Store Data" scopes are needed.

Path Parameters

organizationId *: string
environmentId *: string
storeId *: string

Response

Object store successfully obtained.
Examples
application/json
{ "storeId": "testStoreId", "encrypted": "false", "defaultTtlMillis": 120000, "defaultConfirmationTtlMillis": 10000 }

Create object store createStore

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Create an object store. If you are using connected app, either of "Manage Stores / Manage Store Data" scopes are needed.

Path Parameters

organizationId *: string
environmentId *: string
storeId *: string

Response

Object store successfully created.

Update object store updateStore

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Modify object store attributes. If you are using connected app, either of "Manage Stores / Manage Store Data" scopes are needed.

Path Parameters

organizationId *: string
environmentId *: string
storeId *: string

Response

Object store successfully modified.

Delete object store deleteStore

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Delete the object store. If you are using connected app, either of "Manage Stores / Manage Store Data" scopes are needed.

Path Parameters

organizationId *: string
environmentId *: string
storeId *: string

Response

Object store successfully deleted.

List object store partitions listStorePartitions

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Return a paginated list of keys in this store, along with a token for making a request for the next page of keys. If you are using connected app, "Manage Store Data" scope is needed.

Path Parameters

organizationId *: string
environmentId *: string
storeId *: string

Query Parameters

nextPageToken: string
pageSize: integer

Response

List of keys
Examples
application/json
{ "values": [ "myList1", "myList2", "myList3" ], "nextPageToken": "myList3/8" }

Retrieve values for a partition getPartitionValues

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieve the values stored for the given key. If you are using connected app, you need "Manage Store Data" scope.

Path Parameters

organizationId *: string
environmentId *: string
storeId *: string
partitionId *: string

Query Parameters

inclusion: string
nextPageToken: string
pageSize: integer

Response

Return the values for the given key.
Examples
application/json
{ "values": [ { "index": 33, "metadata": "", "stringValue": "Somewhere in La Mancha, in a place whose name I do not care to remember", "valueType": "STRING" }, { "index": 34, "metadata": "", "stringValue": "It was the best of times, it was the blurst of times", "valueType": "STRING" } ], "nextPageToken": "34" }

Delete partition and its values deletePartition

DELETE

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Remove the object and all the values in the contained list. If you are using connected app, "Manage Store Data" scope is needed.

Path Parameters

organizationId *: string
environmentId *: string
storeId *: string
partitionId *: string

Query Parameters

confirmable *: boolean

Response

Operation completed successfully.

Check partition existence checkPartitionExists

HEAD

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Check whether or not the given partition is already registered in this store. If you are using connected app, "Manage Store Data" scope is needed.

Path Parameters

organizationId *: string
environmentId *: string
storeId *: string
partitionId *: string

Response

Operation completed successfully.

List keys in a partition listPartitionKeys

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieve the given object. If you are using connected app, "Manage Store Data" scope is needed.

Path Parameters

organizationId *: string
environmentId *: string
storeId *: string
partitionId *: string

Query Parameters

beginsWith: string

Response

List of keys belonging to the partition.

Retrieve object by key getObject

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieve the given object. If you are using connected app, "Manage Store Data" scope is needed.

Path Parameters

organizationId *: string
environmentId *: string
storeId *: string
partitionId *: string
keyId *: string

Query Parameters

confirmable *: boolean

Response

The requested resource does not exist on this service.

Alter object non-idempotently alterObject

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/vnd.objectstore.v1.numberoperation+json
Alter the object in a non-idempotent fashion. If you are using connected app, "Manage Store Data" scope is needed.

Path Parameters

organizationId *: string
environmentId *: string
storeId *: string
partitionId *: string
keyId *: string

Request Body

vnd.objectstore.v1.numberoperation+json

Response

The resource already exists on this service.

Create or modify object upsertObject

PUT

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Create/Modify the given object. Total object size must be 10MB or less, and metadata must be 4KB or less. If you are using connected app, "Manage Store Data" scope is needed.

Path Parameters

organizationId *: string
environmentId *: string
storeId *: string
partitionId *: string
keyId *: string

Query Parameters

confirmable *: boolean

Request Body

json

Response

The requested resource does not exist on this service.

Delete object by key deleteObject

DELETE

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Remove the object with the given ID. If you are using connected app, "Manage Store Data" scope is needed.

Path Parameters

organizationId *: string
environmentId *: string
storeId *: string
partitionId *: string
keyId *: string

Query Parameters

confirmable *: boolean

Response

Operation completed successfully.

Check if object exists checkObjectExists

HEAD

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Check if the object exists. "Manage Store Data" scope is needed.

Path Parameters

organizationId *: string
environmentId *: string
storeId *: string
partitionId *: string
keyId *: string

Query Parameters

confirmable *: boolean

Response

Operation completed successfully.

Acknowledge object operation ackObjectOperation

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Ack the operation. If you are using connected app, "Manage Store Data" scope is needed.

Path Parameters

confirmationId *: string
The confirmation ID to identify the target resource.
organizationId *: string
environmentId *: string
storeId *: string
partitionId *: string
keyId *: string

Response

Operation completed successfully.

Extend operation time to live extendOperationTtl

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Extend the operation's time to live. If you are using connected app, "Manage Store Data" scope is needed.

Path Parameters

confirmationId *: string
The confirmation ID to identify the target resource.
organizationId *: string
environmentId *: string
storeId *: string
partitionId *: string
keyId *: string

Request Body

json

Response

Operation completed successfully.

Reject object operation nackObjectOperation

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Nack the operation. If you are using connected app, "Manage Store Data" scope is needed.

Path Parameters

confirmationId *: string
The confirmation ID to identify the target resource.
organizationId *: string
environmentId *: string
storeId *: string
partitionId *: string
keyId *: string

Response

Operation completed successfully.

List available object store regions listRegions

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieve a list of regions in which the service is available. If you are using connected app, no particular scope is needed.

Path Parameters

organizationId *: string

Response

Successfully return a JSON array containing objects for each region.
Examples
application/json
[ { "id": "mars-east-1", "name": "Mars East (Elysium)", "url": "http://object-store.mars-east-1.cloudhub.com" }, { "id": "mars-west-1", "name": "Mars West (Oxia Palus)", "url": "http://object-store.mars-west-1.cloudhub.com" } ]