# List credential keys

GET https://api.bctrl.ai/v1/vault

Reference: https://platform.bctrl.ai/api/api-reference/vault/list

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: bctrl API
  version: 1.0.0
paths:
  /v1/vault:
    get:
      operationId: list
      summary: List credential keys
      tags:
        - subpackage_vault
      parameters:
        - name: prefix
          in: query
          required: false
          schema:
            type: string
        - name: meta
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/V1VaultGetParametersMeta'
        - name: origin
          in: query
          required: false
          schema:
            type: string
        - name: hasTotp
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/V1VaultGetParametersHasTotp'
        - name: limit
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/V1VaultGetParametersLimit'
        - name: syncMetadata
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/V1VaultGetParametersSyncMetadata'
        - name: Authorization
          in: header
          description: Use Bearer <api-key>.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Credential key list or metadata list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/vault_list_Response_200'
servers:
  - url: https://api.bctrl.ai
  - url: http://localhost:8787
components:
  schemas:
    V1VaultGetParametersMeta1:
      type: string
      enum:
        - '0'
      title: V1VaultGetParametersMeta1
    V1VaultGetParametersMeta2:
      type: string
      enum:
        - '1'
      title: V1VaultGetParametersMeta2
    V1VaultGetParametersMeta3:
      type: string
      enum:
        - 'true'
      title: V1VaultGetParametersMeta3
    V1VaultGetParametersMeta4:
      type: string
      enum:
        - 'false'
      title: V1VaultGetParametersMeta4
    V1VaultGetParametersMeta:
      oneOf:
        - type: boolean
        - $ref: '#/components/schemas/V1VaultGetParametersMeta1'
        - $ref: '#/components/schemas/V1VaultGetParametersMeta2'
        - $ref: '#/components/schemas/V1VaultGetParametersMeta3'
        - $ref: '#/components/schemas/V1VaultGetParametersMeta4'
      title: V1VaultGetParametersMeta
    V1VaultGetParametersHasTotp1:
      type: string
      enum:
        - '0'
      title: V1VaultGetParametersHasTotp1
    V1VaultGetParametersHasTotp2:
      type: string
      enum:
        - '1'
      title: V1VaultGetParametersHasTotp2
    V1VaultGetParametersHasTotp3:
      type: string
      enum:
        - 'true'
      title: V1VaultGetParametersHasTotp3
    V1VaultGetParametersHasTotp4:
      type: string
      enum:
        - 'false'
      title: V1VaultGetParametersHasTotp4
    V1VaultGetParametersHasTotp:
      oneOf:
        - type: boolean
        - $ref: '#/components/schemas/V1VaultGetParametersHasTotp1'
        - $ref: '#/components/schemas/V1VaultGetParametersHasTotp2'
        - $ref: '#/components/schemas/V1VaultGetParametersHasTotp3'
        - $ref: '#/components/schemas/V1VaultGetParametersHasTotp4'
      title: V1VaultGetParametersHasTotp
    V1VaultGetParametersLimit:
      oneOf:
        - type: integer
        - type: string
      title: V1VaultGetParametersLimit
    V1VaultGetParametersSyncMetadata1:
      type: string
      enum:
        - '0'
      title: V1VaultGetParametersSyncMetadata1
    V1VaultGetParametersSyncMetadata2:
      type: string
      enum:
        - '1'
      title: V1VaultGetParametersSyncMetadata2
    V1VaultGetParametersSyncMetadata3:
      type: string
      enum:
        - 'true'
      title: V1VaultGetParametersSyncMetadata3
    V1VaultGetParametersSyncMetadata4:
      type: string
      enum:
        - 'false'
      title: V1VaultGetParametersSyncMetadata4
    V1VaultGetParametersSyncMetadata:
      oneOf:
        - type: boolean
        - $ref: '#/components/schemas/V1VaultGetParametersSyncMetadata1'
        - $ref: '#/components/schemas/V1VaultGetParametersSyncMetadata2'
        - $ref: '#/components/schemas/V1VaultGetParametersSyncMetadata3'
        - $ref: '#/components/schemas/V1VaultGetParametersSyncMetadata4'
      title: V1VaultGetParametersSyncMetadata
    VaultListResponse2000:
      type: object
      properties:
        keys:
          type: array
          items:
            type: string
      required:
        - keys
      title: VaultListResponse2000
    V1VaultGetResponsesContentApplicationJsonSchemaOneOf1ItemsItemsSource:
      type: string
      enum:
        - native
        - 1password
      title: V1VaultGetResponsesContentApplicationJsonSchemaOneOf1ItemsItemsSource
    V1VaultGetResponsesContentApplicationJsonSchemaOneOf1ItemsItems:
      type: object
      properties:
        hasTotp:
          type: boolean
        key:
          type: string
        label:
          type: string
        originPatterns:
          type: array
          items:
            type: string
        origins:
          type: array
          items:
            type: string
        source:
          $ref: >-
            #/components/schemas/V1VaultGetResponsesContentApplicationJsonSchemaOneOf1ItemsItemsSource
        sourceDisplayName:
          type: string
      required:
        - hasTotp
        - key
        - source
      title: V1VaultGetResponsesContentApplicationJsonSchemaOneOf1ItemsItems
    VaultListResponse2001:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: >-
              #/components/schemas/V1VaultGetResponsesContentApplicationJsonSchemaOneOf1ItemsItems
      required:
        - items
      title: VaultListResponse2001
    vault_list_Response_200:
      oneOf:
        - $ref: '#/components/schemas/VaultListResponse2000'
        - $ref: '#/components/schemas/VaultListResponse2001'
      title: vault_list_Response_200
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Use Bearer <api-key>.

```

## SDK Code Examples

```python
import requests

url = "https://api.bctrl.ai/v1/vault"

querystring = {"prefix":"work-","meta":"true","origin":"https://app.example.com","hasTotp":"false","limit":"50","syncMetadata":"true"}

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.get(url, json=payload, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.bctrl.ai/v1/vault?prefix=work-&meta=true&origin=https%3A%2F%2Fapp.example.com&hasTotp=false&limit=50&syncMetadata=true';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bctrl.ai/v1/vault?prefix=work-&meta=true&origin=https%3A%2F%2Fapp.example.com&hasTotp=false&limit=50&syncMetadata=true"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.bctrl.ai/v1/vault?prefix=work-&meta=true&origin=https%3A%2F%2Fapp.example.com&hasTotp=false&limit=50&syncMetadata=true")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.bctrl.ai/v1/vault?prefix=work-&meta=true&origin=https%3A%2F%2Fapp.example.com&hasTotp=false&limit=50&syncMetadata=true")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.bctrl.ai/v1/vault?prefix=work-&meta=true&origin=https%3A%2F%2Fapp.example.com&hasTotp=false&limit=50&syncMetadata=true', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.bctrl.ai/v1/vault?prefix=work-&meta=true&origin=https%3A%2F%2Fapp.example.com&hasTotp=false&limit=50&syncMetadata=true");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.bctrl.ai/v1/vault?prefix=work-&meta=true&origin=https%3A%2F%2Fapp.example.com&hasTotp=false&limit=50&syncMetadata=true")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```