# Object Store v2 API

Manage object stores, partitions, and key-value entries across environments and regions in Object Store v2.

- **Version:** 1.0.0
- **Category:** Storage
- **OpenAPI Spec:** [api.yaml](https://dev-portal.mulesoft.com/apis/object-store-v2/api.yaml)

## Servers
- `https://object-store-us-east-1.anypoint.mulesoft.com/api/v1`

## Operations (19)
### GET /organizations/{organizationId}/environments/{environmentId}/stores

**Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidStores`
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.

**Parameters:**
| `nextPageToken` | query | When requesting a series of result pages, specify which page this request should resume on. | optional |
| `pageSize` | query | Limit the number of elements in the response. | optional |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |

### GET /organizations/{organizationId}/environments/{environmentId}/stores/{storeId}

**Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidStoresByStoreid`
Get object store details. If you are using connected app, either of "View Stores / Manage Stores / Manage Store Data" scopes  are needed.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `storeId` | query | The store ID to identify the target resource. | required |

### PUT /organizations/{organizationId}/environments/{environmentId}/stores/{storeId}

**Operation ID:** `updateOrganizationsByOrganizationidEnvironmentsByEnvironmentidStoresByStoreid`
Create an object store. If you are using connected app, either of "Manage Stores / Manage Store Data" scopes  are needed.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `storeId` | query | The store ID to identify the target resource. | required |

### PATCH /organizations/{organizationId}/environments/{environmentId}/stores/{storeId}

**Operation ID:** `patchOrganizationsByOrganizationidEnvironmentsByEnvironmentidStoresByStoreid`
Modify object store attributes. If you are using connected app, either of "Manage Stores / Manage Store Data" scopes  are needed.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `storeId` | query | The store ID to identify the target resource. | required |

### DELETE /organizations/{organizationId}/environments/{environmentId}/stores/{storeId}

**Operation ID:** `deleteOrganizationsByOrganizationidEnvironmentsByEnvironmentidStoresByStoreid`
Delete the object store. If you are using connected app, either of "Manage Stores / Manage Store Data" scopes  are needed.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `storeId` | query | The store ID to identify the target resource. | required |

### GET /organizations/{organizationId}/environments/{environmentId}/stores/{storeId}/partitions

**Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidStoresByStoreidPartitions`
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.

**Parameters:**
| `nextPageToken` | query | When requesting a series of result pages, specify which page this request should resume on. | optional |
| `pageSize` | query | Limit the number of elements in the response. | optional |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `storeId` | query | The store ID to identify the target resource. | required |

### GET /organizations/{organizationId}/environments/{environmentId}/stores/{storeId}/partitions/{partitionId}

**Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidStoresByStoreidPartitionsByPartitionid`
Retrieve the values stored for the given key. If you are using connected app, you need "Manage Store Data" scope.

**Parameters:**
| `inclusion` | query | Defines what to fetch | optional |
| `nextPageToken` | query | When requesting a series of result pages, specify which page this request should resume on. | optional |
| `pageSize` | query | Limit the number of elements in the response. | optional |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `storeId` | query | The store ID to identify the target resource. | required |
| `partitionId` | query | The partition ID to identify the target resource. | required |

### DELETE /organizations/{organizationId}/environments/{environmentId}/stores/{storeId}/partitions/{partitionId}

**Operation ID:** `deleteOrganizationsByOrganizationidEnvironmentsByEnvironmentidStoresByStoreidPartitionsByPartitionid`
Remove the object and all the values in the contained list. If you are using connected app, "Manage Store Data" scope is needed.

**Parameters:**
| `confirmable` | query | Defines whether or not an operation should be confirmed.
 | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `storeId` | query | The store ID to identify the target resource. | required |
| `partitionId` | query | The partition ID to identify the target resource. | required |

### HEAD /organizations/{organizationId}/environments/{environmentId}/stores/{storeId}/partitions/{partitionId}

**Operation ID:** `headOrganizationsByOrganizationidEnvironmentsByEnvironmentidStoresByStoreidPartitionsByPartitionid`
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.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `storeId` | query | The store ID to identify the target resource. | required |
| `partitionId` | query | The partition ID to identify the target resource. | required |

### GET /organizations/{organizationId}/environments/{environmentId}/stores/{storeId}/partitions/{partitionId}/keys

**Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidStoresByStoreidPartitionsByPartitionidKeys`
Retrieve the given object. If you are using connected app, "Manage Store Data" scope is needed.

**Parameters:**
| `beginsWith` | query | Searches the field from the left using the passed string.
 | optional |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `storeId` | query | The store ID to identify the target resource. | required |
| `partitionId` | query | The partition ID to identify the target resource. | required |

### GET /organizations/{organizationId}/environments/{environmentId}/stores/{storeId}/partitions/{partitionId}/keys/{keyId}

**Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidStoresByStoreidPartitionsByPartitionidKeysByKeyid`
Retrieve the given object. If you are using connected app, "Manage Store Data" scope is needed.

**Parameters:**
| `confirmable` | query | Defines whether or not an operation should be confirmed.
 | required |
| `storeId` | query | The store ID to identify the target resource. | required |
| `keyId` | query | The key ID to identify the target resource. | required |
| `partitionId` | query | The partition ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |

### POST /organizations/{organizationId}/environments/{environmentId}/stores/{storeId}/partitions/{partitionId}/keys/{keyId}

**Operation ID:** `createOrganizationsByOrganizationidEnvironmentsByEnvironmentidStoresByStoreidPartitionsByPartitionidKeysByKeyid`
Alter the object in a non-idempotent fashion. If you are using connected app, "Manage Store Data" scope is needed.

**Parameters:**
| `storeId` | query | The store ID to identify the target resource. | required |
| `keyId` | query | The key ID to identify the target resource. | required |
| `partitionId` | query | The partition ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |

### PUT /organizations/{organizationId}/environments/{environmentId}/stores/{storeId}/partitions/{partitionId}/keys/{keyId}

**Operation ID:** `updateOrganizationsByOrganizationidEnvironmentsByEnvironmentidStoresByStoreidPartitionsByPartitionidKeysByKeyid`
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.

**Parameters:**
| `confirmable` | query | Defines whether or not an operation should be confirmed.
 | required |
| `storeId` | query | The store ID to identify the target resource. | required |
| `keyId` | query | The key ID to identify the target resource. | required |
| `partitionId` | query | The partition ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |

### DELETE /organizations/{organizationId}/environments/{environmentId}/stores/{storeId}/partitions/{partitionId}/keys/{keyId}

**Operation ID:** `deleteOrganizationsByOrganizationidEnvironmentsByEnvironmentidStoresByStoreidPartitionsByPartitionidKeysByKeyid`
Remove the object with the given ID. If you are using connected app, "Manage Store Data" scope is needed.

**Parameters:**
| `confirmable` | query | Defines whether or not an operation should be confirmed.
 | required |
| `storeId` | query | The store ID to identify the target resource. | required |
| `keyId` | query | The key ID to identify the target resource. | required |
| `partitionId` | query | The partition ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |

### HEAD /organizations/{organizationId}/environments/{environmentId}/stores/{storeId}/partitions/{partitionId}/keys/{keyId}

**Operation ID:** `headOrganizationsByOrganizationidEnvironmentsByEnvironmentidStoresByStoreidPartitionsByPartitionidKeysByKeyid`
Check if the object exists. "Manage Store Data" scope is needed.

**Parameters:**
| `confirmable` | query | Defines whether or not an operation should be confirmed.
 | required |
| `storeId` | query | The store ID to identify the target resource. | required |
| `keyId` | query | The key ID to identify the target resource. | required |
| `partitionId` | query | The partition ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |

### POST /organizations/{organizationId}/environments/{environmentId}/stores/{storeId}/partitions/{partitionId}/keys/{keyId}/confirmations/{confirmationId}

**Operation ID:** `createOrganizationsByOrganizationidEnvironmentsByEnvironmentidStoresByStoreidPartitionsByPartitionidKeysByKeyidConfirmationsByConfirmationid`
Ack the operation. If you are using connected app, "Manage Store Data" scope is needed.

**Parameters:**
| `confirmationId` | query | The confirmation ID to identify the target resource. | required |
| `storeId` | query | The store ID to identify the target resource. | required |
| `keyId` | query | The key ID to identify the target resource. | required |
| `partitionId` | query | The partition ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |

### PATCH /organizations/{organizationId}/environments/{environmentId}/stores/{storeId}/partitions/{partitionId}/keys/{keyId}/confirmations/{confirmationId}

**Operation ID:** `patchOrganizationsByOrganizationidEnvironmentsByEnvironmentidStoresByStoreidPartitionsByPartitionidKeysByKeyidConfirmationsByConfirmationid`
Extend the operation's time to live. If you are using connected app, "Manage Store Data" scope is needed.

**Parameters:**
| `confirmationId` | query | The confirmation ID to identify the target resource. | required |
| `storeId` | query | The store ID to identify the target resource. | required |
| `keyId` | query | The key ID to identify the target resource. | required |
| `partitionId` | query | The partition ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |

### DELETE /organizations/{organizationId}/environments/{environmentId}/stores/{storeId}/partitions/{partitionId}/keys/{keyId}/confirmations/{confirmationId}

**Operation ID:** `deleteOrganizationsByOrganizationidEnvironmentsByEnvironmentidStoresByStoreidPartitionsByPartitionidKeysByKeyidConfirmationsByConfirmationid`
Nack the operation. If you are using connected app, "Manage Store Data" scope is needed.

**Parameters:**
| `confirmationId` | query | The confirmation ID to identify the target resource. | required |
| `storeId` | query | The store ID to identify the target resource. | required |
| `keyId` | query | The key ID to identify the target resource. | required |
| `partitionId` | query | The partition ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |

### GET /organizations/{organizationId}/regions

**Operation ID:** `getOrganizationsByOrganizationidRegions`
Retrieve a list of regions in which the service is available. If you are using connected app, no particular scope is needed.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |