# FinSpace User Environment Management service API

> FinSpace User Environment Management service API on Apizie: 34 endpoints (A list of all of your FinSpace environments., Create a new FinSpace environment., Returns a list of all the changesets for a database., Creates a changeset for a kdb database. A changeset allows you to add and delete existing files by using an…, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:amazonaws-finspace/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:amazonaws-finspace`
- Category: Cloud
- Status: byok
- Source: https://github.com/mermade/aws2openapi
- Page: https://apizie.tech/api/cloud/amazonaws-finspace
- OpenAPI: https://apizie.tech/api/cloud/amazonaws-finspace/openapi.json

The FinSpace management service provides the APIs for managing FinSpace environments.

## Endpoints

### A list of all of your FinSpace environments.
`GET https://apizie.tech/v1/cloud:amazonaws-finspace/list-environments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| nextToken | string | no | A token generated by FinSpace that specifies where to continue pagination if a previous request was truncated. To get the next set of… |
| maxResults | integer | no | The maximum number of results to return in this request. |

### Create a new FinSpace environment.
`POST https://apizie.tech/v1/cloud:amazonaws-finspace/create-environment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Returns a list of all the changesets for a database.
`GET https://apizie.tech/v1/cloud:amazonaws-finspace/list-kx-changesets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| environmentId | string | yes | A unique identifier for the kdb environment. |
| databaseName | string | yes | The name of the kdb database. |
| nextToken | string | no | A token that indicates where a results page should begin. |
| maxResults | integer | no | The maximum number of results to return in this request. |

### Creates a changeset for a kdb database. A changeset allows you to add and delete existing files by using an…
`POST https://apizie.tech/v1/cloud:amazonaws-finspace/create-kx-changeset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| environmentId | string | yes | A unique identifier of the kdb environment. |
| databaseName | string | yes | The name of the kdb database. |
| body | object | yes | JSON request body |

### Returns a list of clusters.
`GET https://apizie.tech/v1/cloud:amazonaws-finspace/list-kx-clusters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| environmentId | string | yes | A unique identifier for the kdb environment. |
| clusterType | string | no | Specifies the type of KDB database that is being created. The following types are available: HDB – A Historical Database. The data is only… |
| maxResults | integer | no | The maximum number of results to return in this request. |
| nextToken | string | no | A token that indicates where a results page should begin. |

### Creates a new kdb cluster.
`POST https://apizie.tech/v1/cloud:amazonaws-finspace/create-kx-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| environmentId | string | yes | A unique identifier for the kdb environment. |
| body | object | yes | JSON request body |

### Returns a list of all the databases in the kdb environment.
`GET https://apizie.tech/v1/cloud:amazonaws-finspace/list-kx-databases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| environmentId | string | yes | A unique identifier for the kdb environment. |
| nextToken | string | no | A token that indicates where a results page should begin. |
| maxResults | integer | no | The maximum number of results to return in this request. |

### Creates a new kdb database in the environment.
`POST https://apizie.tech/v1/cloud:amazonaws-finspace/create-kx-database` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| environmentId | string | yes | A unique identifier for the kdb environment. |
| body | object | yes | JSON request body |

### Returns a list of kdb environments created in an account.
`GET https://apizie.tech/v1/cloud:amazonaws-finspace/list-kx-environments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| nextToken | string | no | A token that indicates where a results page should begin. |
| maxResults | integer | no | The maximum number of results to return in this request. |

### Creates a managed kdb environment for the account.
`POST https://apizie.tech/v1/cloud:amazonaws-finspace/create-kx-environment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Lists all the users in a kdb environment.
`GET https://apizie.tech/v1/cloud:amazonaws-finspace/list-kx-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| environmentId | string | yes | A unique identifier for the kdb environment. |
| nextToken | string | no | A token that indicates where a results page should begin. |
| maxResults | integer | no | The maximum number of results to return in this request. |

### Creates a user in FinSpace kdb environment with an associated IAM role.
`POST https://apizie.tech/v1/cloud:amazonaws-finspace/create-kx-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| environmentId | string | yes | A unique identifier for the kdb environment where you want to create a user. |
| body | object | yes | JSON request body |

### Returns the FinSpace environment object.
`GET https://apizie.tech/v1/cloud:amazonaws-finspace/get-environment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| environmentId | string | yes | The identifier of the FinSpace environment. |

### Update your FinSpace environment.
`POST https://apizie.tech/v1/cloud:amazonaws-finspace/update-environment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| environmentId | string | yes | The identifier of the FinSpace environment. |
| body | object | yes | JSON request body |

### Delete an FinSpace environment.
`POST https://apizie.tech/v1/cloud:amazonaws-finspace/delete-environment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| environmentId | string | yes | The identifier for the FinSpace environment. |

### Retrieves information about a kdb cluster.
`GET https://apizie.tech/v1/cloud:amazonaws-finspace/get-kx-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| environmentId | string | yes | A unique identifier for the kdb environment. |
| clusterName | string | yes | The name of the cluster that you want to retrieve. |

### Deletes a kdb cluster.
`POST https://apizie.tech/v1/cloud:amazonaws-finspace/delete-kx-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| environmentId | string | yes | A unique identifier for the kdb environment. |
| clusterName | string | yes | The name of the cluster that you want to delete. |
| clientToken | string | no | A token that ensures idempotency. This token expires in 10 minutes. |

### Deletes the specified database and all of its associated data. This action is irreversible. You must copy…
`POST https://apizie.tech/v1/cloud:amazonaws-finspace/delete-kx-database` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| environmentId | string | yes | A unique identifier for the kdb environment. |
| databaseName | string | yes | The name of the kdb database that you want to delete. |
| clientToken | string | yes | A token that ensures idempotency. This token expires in 10 minutes. |

### Retrieves all the information for the specified kdb environment.
`GET https://apizie.tech/v1/cloud:amazonaws-finspace/get-kx-environment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| environmentId | string | yes | A unique identifier for the kdb environment. |

### Updates information for the given kdb environment.
`POST https://apizie.tech/v1/cloud:amazonaws-finspace/update-kx-environment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| environmentId | string | yes | A unique identifier for the kdb environment. |
| body | object | yes | JSON request body |

### Deletes the kdb environment. This action is irreversible. Deleting a kdb environment will remove all the…
`POST https://apizie.tech/v1/cloud:amazonaws-finspace/delete-kx-environment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| environmentId | string | yes | A unique identifier for the kdb environment. |

### Retrieves information about the specified kdb user.
`GET https://apizie.tech/v1/cloud:amazonaws-finspace/get-kx-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| userName | string | yes | A unique identifier for the user. |
| environmentId | string | yes | A unique identifier for the kdb environment. |

### Updates the user details. You can only update the IAM role associated with a user.
`POST https://apizie.tech/v1/cloud:amazonaws-finspace/update-kx-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| environmentId | string | yes | A unique identifier for the kdb environment. |
| userName | string | yes | A unique identifier for the user. |
| body | object | yes | JSON request body |

### Deletes a user in the specified kdb environment.
`POST https://apizie.tech/v1/cloud:amazonaws-finspace/delete-kx-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| userName | string | yes | A unique identifier for the user that you want to delete. |
| environmentId | string | yes | A unique identifier for the kdb environment. |

### Returns information about a kdb changeset.
`GET https://apizie.tech/v1/cloud:amazonaws-finspace/get-kx-changeset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| environmentId | string | yes | A unique identifier for the kdb environment. |
| databaseName | string | yes | The name of the kdb database. |
| changesetId | string | yes | A unique identifier of the changeset for which you want to retrieve data. |

### Retrieves a connection string for a user to connect to a kdb cluster. You must call this API using the same…
`GET https://apizie.tech/v1/cloud:amazonaws-finspace/get-kx-connection-string` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| userArn | string | yes | The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM… |
| environmentId | string | yes | A unique identifier for the kdb environment. |
| clusterName | string | yes | A name of the kdb cluster. |

### Returns database information for the specified environment ID.
`GET https://apizie.tech/v1/cloud:amazonaws-finspace/get-kx-database` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| environmentId | string | yes | A unique identifier for the kdb environment. |
| databaseName | string | yes | The name of the kdb database. |

### Updates information for the given kdb database.
`POST https://apizie.tech/v1/cloud:amazonaws-finspace/update-kx-database` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| environmentId | string | yes | A unique identifier for the kdb environment. |
| databaseName | string | yes | The name of the kdb database. |
| body | object | yes | JSON request body |

### Lists all the nodes in a kdb cluster.
`GET https://apizie.tech/v1/cloud:amazonaws-finspace/list-kx-cluster-nodes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| environmentId | string | yes | A unique identifier for the kdb environment. |
| clusterName | string | yes | A unique name for the cluster. |
| nextToken | string | no | A token that indicates where a results page should begin. |
| maxResults | integer | no | The maximum number of results to return in this request. |

### A list of all tags for a resource.
`GET https://apizie.tech/v1/cloud:amazonaws-finspace/list-tags-for-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | The Amazon Resource Name of the resource. |

### Adds metadata tags to a FinSpace resource.
`POST https://apizie.tech/v1/cloud:amazonaws-finspace/tag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | The Amazon Resource Name (ARN) for the resource. |
| body | object | yes | JSON request body |

### Removes metadata tags from a FinSpace resource.
`POST https://apizie.tech/v1/cloud:amazonaws-finspace/untag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| resourceArn | string | yes | A FinSpace resource from which you want to remove a tag or tags. The value for this parameter is an Amazon Resource Name (ARN). |
| tagKeys | array | yes | The tag keys (names) of one or more tags to be removed. |

### Updates the databases mounted on a kdb cluster, which includes the changesetId and all the dbPaths to be…
`POST https://apizie.tech/v1/cloud:amazonaws-finspace/update-kx-cluster-databases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| environmentId | string | yes | The unique identifier of a kdb environment. |
| clusterName | string | yes | A unique name for the cluster that you want to modify. |
| body | object | yes | JSON request body |

### Updates environment network to connect to your internal network by using a transit gateway. This API…
`POST https://apizie.tech/v1/cloud:amazonaws-finspace/update-kx-environment-network` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| environmentId | string | yes | A unique identifier for the kdb environment. |
| body | object | yes | JSON request body |

## Example
```
curl "https://apizie.tech/v1/cloud:amazonaws-finspace/list-environments" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the FinSpace User Environment Management service API?
Create a free Apizie key, then send GET https://apizie.tech/v1/cloud:amazonaws-finspace/list-environments with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the FinSpace User Environment Management service API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. FinSpace User Environment Management service itself also needs your own key from amazonaws.com.

### Can AI agents use the FinSpace User Environment Management service API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:amazonaws-finspace.

### What is the status of the FinSpace User Environment Management service API?
Needs your own provider key (bring your own key)