# Get vector

URL: https://docs.hanzo.ai/docs/openapi/provisioning/get-provisioning-vector-by-name

> Returns one vector collection's metadata.

`GET /v1/provisioning/vector/{name}`

> [Provisioning →](https://docs.hanzo.ai/docs/openapi/provisioning) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                                      |
| ------------- | ---------------------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/provisioning/vector/{name}` |
| **Method**    | `GET`                                                |
| **Operation** | `get_provisioning_vector_by_name`                    |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`               |

Returns one vector collection's metadata. It carries the
collection's status and the gateway address it is reached at, and no username:
the backend authenticates with a shared, out-of-band key rather than a
per-collection credential, so there is no per-resource user to report.

## Request

1 field.

| Field  | In   | Type   | Required | Description                                            |
| ------ | ---- | ------ | -------- | ------------------------------------------------------ |
| `name` | path | string | yes      | Name is the resource's org-unique slug, from the path. |

## Response

| Status    | Body                             | Meaning |
| --------- | -------------------------------- | ------- |
| `200`     | provisioning.provisionedResource | ok      |
| `default` | problem-details                  | refused |

`200` body — 8 fields.

| Field      | In   | Type            | Always | Description                                                                                                                                        |
| ---------- | ---- | --------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `database` | body | string          | —      | Database is the logical database, collection, index or bucket this resource resolves to on its backend.                                            |
| `host`     | body | string          | —      | Host is the address that actually routes to this resource — a dedicated instance's own in-cluster Service, or the public gateway for a shared one. |
| `id`       | body | string          | —      | ID is the resource's server-minted handle, "rs\_"-prefixed.                                                                                        |
| `kind`     | body | string          | —      | Kind is the product: sql, vector, datastore, kv, search, s3 or docdb.                                                                              |
| `name`     | body | string          | —      | Name is the org-unique slug the caller provisioned the resource under.                                                                             |
| `port`     | body | integer (int64) | —      | Port is the port a client connects to on Host.                                                                                                     |
| `status`   | body | string          | —      | Status is "ready", or "provisioning" while a dedicated instance is still being materialized.                                                       |
| `username` | body | string          | —      | Username is the credential's user, for the kinds that mint one per resource.                                                                       |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo provisioning vector get <name>
```

**SDK**

**.ts**

```ts
import { Configuration, ProvisioningApi } from 'hanzoai';

const api = new ProvisioningApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getProvisioningVectorByName({ name: 'name' });
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import ProvisioningApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = ProvisioningApi(client).get_provisioning_vector_by_name(name='name')
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.ProvisioningAPI.GetProvisioningVectorByName(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, provisioning_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = provisioning_api::get_provisioning_vector_by_name(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.ProvisioningApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new ProvisioningApi(client).getProvisioningVectorByName();
```

**HTTP**

```bash
curl https://api.hanzo.ai/v1/provisioning/vector/<name> \
  -H "Authorization: Bearer $HANZO_API_KEY"
```

**MCP**

Tool `provisioning`, op `get_provisioning_vector_by_name` — POST the JSON-RPC envelope to `https://api.hanzo.ai/v1/mcp`.

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "provisioning",
         "arguments": {
           "op": "get_provisioning_vector_by_name",
           "input": {
             "name": "<name>"
           }
         }
       }
     }'
```

---

[Provisioning API](https://docs.hanzo.ai/docs/openapi/provisioning) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)