Get API Keys

POST /v2/workspace/apikeys/get

Get API Keys

cURL

curl --request POST \
  --url https://api.velt.dev/v2/workspace/apikeys/get \
  --header 'Content-Type: application/json' \
  --header 'x-velt-workspace-auth-token: <x-velt-workspace-auth-token>' \
  --header 'x-velt-workspace-id: <x-velt-workspace-id>' \
  --data '
{
  "data": {
    "apiKeys": [
      "<string>"
    ],
    "pageSize": 123,
    "pageToken": "<string>"
  }
}
'

import requests

url = "https://api.velt.dev/v2/workspace/apikeys/get"

payload = { "data": {
        "apiKeys": ["<string>"],
        "pageSize": 123,
        "pageToken": "<string>"
    } }
headers = {
    "x-velt-workspace-id": "<x-velt-workspace-id>",
    "x-velt-workspace-auth-token": "<x-velt-workspace-auth-token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-velt-workspace-id': '<x-velt-workspace-id>',
    'x-velt-workspace-auth-token': '<x-velt-workspace-auth-token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({data: {apiKeys: ['<string>'], pageSize: 123, pageToken: '<string>'}})
};

fetch('https://api.velt.dev/v2/workspace/apikeys/get', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.velt.dev/v2/workspace/apikeys/get",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'data' => [
        'apiKeys' => [
                '<string>'
        ],
        'pageSize' => 123,
        'pageToken' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-velt-workspace-auth-token: <x-velt-workspace-auth-token>",
    "x-velt-workspace-id: <x-velt-workspace-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.velt.dev/v2/workspace/apikeys/get"

	payload := strings.NewReader("{\n  \"data\": {\n    \"apiKeys\": [\n      \"<string>\"\n    ],\n    \"pageSize\": 123,\n    \"pageToken\": \"<string>\"\n  }\n}")

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

	req.Header.Add("x-velt-workspace-id", "<x-velt-workspace-id>")
	req.Header.Add("x-velt-workspace-auth-token", "<x-velt-workspace-auth-token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.velt.dev/v2/workspace/apikeys/get")
  .header("x-velt-workspace-id", "<x-velt-workspace-id>")
  .header("x-velt-workspace-auth-token", "<x-velt-workspace-auth-token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {\n    \"apiKeys\": [\n      \"<string>\"\n    ],\n    \"pageSize\": 123,\n    \"pageToken\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.velt.dev/v2/workspace/apikeys/get")

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

request = Net::HTTP::Post.new(url)
request["x-velt-workspace-id"] = '<x-velt-workspace-id>'
request["x-velt-workspace-auth-token"] = '<x-velt-workspace-auth-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": {\n    \"apiKeys\": [\n      \"<string>\"\n    ],\n    \"pageSize\": 123,\n    \"pageToken\": \"<string>\"\n  }\n}"

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

{
  "result": {
    "status": "success",
    "message": "API keys retrieved successfully.",
    "data": [
      {
        "id": "velt_api_key_1",
        "apiKeyName": "Production Key",
        "type": "production"
      },
      {
        "id": "velt_api_key_2",
        "apiKeyName": "Testing Key",
        "type": "testing"
      }
    ],
    "nextPageToken": "eyJsYXN0SWQiOiJ2ZWx0X2FwaV9rZXlfMiJ9"
  }
}

Use this API to retrieve a list of API keys for a workspace.

This endpoint uses workspace-level auth: pass x-velt-workspace-id and x-velt-workspace-auth-token (from the Create Workspace response) as headers.

Endpoint

POST https://api.velt.dev/v2/workspace/apikeys/get

Headers

x-velt-workspace-id · string · required

Your Workspace ID.

x-velt-workspace-auth-token · string · required

Your workspace Auth Token.

Body

Params

data · object

Show properties

apiKeys · string[]

Filter results to specific API key IDs.

pageSize · number

Number of results per page. Max 100. Defaults to 100.

pageToken · string

Pagination token from a previous response to fetch the next page.

Example Request

{
  "data": {
    "pageSize": 50
  }
}

Example Response

Success Response

{
  "result": {
    "status": "success",
    "message": "API keys retrieved successfully.",
    "data": [
      {
        "id": "velt_api_key_1",
        "apiKeyName": "Production Key",
        "type": "production"
      },
      {
        "id": "velt_api_key_2",
        "apiKeyName": "Testing Key",
        "type": "testing"
      }
    ],
    "nextPageToken": "eyJsYXN0SWQiOiJ2ZWx0X2FwaV9rZXlfMiJ9"
  }
}

If there are more results, the response includes a nextPageToken string. Pass this value as pageToken in your next request to fetch the next page. When no nextPageToken is returned, you have reached the last page.

Failure Response

{
  "error": {
    "status": "PERMISSION_DENIED",
    "message": "Invalid workspace credentials."
  }
}

{
  "result": {
    "status": "success",
    "message": "API keys retrieved successfully.",
    "data": [
      {
        "id": "velt_api_key_1",
        "apiKeyName": "Production Key",
        "type": "production"
      },
      {
        "id": "velt_api_key_2",
        "apiKeyName": "Testing Key",
        "type": "testing"
      }
    ],
    "nextPageToken": "eyJsYXN0SWQiOiJ2ZWx0X2FwaV9rZXlfMiJ9"
  }
}