List API Keys

GET /v1/accounts/{account_id}/users/{user_id}/apiKeys

List API Keys

cURL

curl --request GET \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/users/{user_id}/apiKeys \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.fireworks.ai/v1/accounts/{account_id}/users/{user_id}/apiKeys"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.fireworks.ai/v1/accounts/{account_id}/users/{user_id}/apiKeys', 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.fireworks.ai/v1/accounts/{account_id}/users/{user_id}/apiKeys",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.fireworks.ai/v1/accounts/{account_id}/users/{user_id}/apiKeys"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.fireworks.ai/v1/accounts/{account_id}/users/{user_id}/apiKeys")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fireworks.ai/v1/accounts/{account_id}/users/{user_id}/apiKeys")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "apiKeys": [
    {
      "keyId": "<string>",
      "displayName": "<string>",
      "key": "<string>",
      "createTime": "2023-11-07T05:31:56Z",
      "secure": true,
      "email": "<string>",
      "prefix": "<string>",
      "expireTime": "2023-11-07T05:31:56Z",
      "annotations": {},
      "lastUsed": "2023-11-07T05:31:56Z",
      "isFirepass": true
    }
  ],
  "nextPageToken": "<string>",
  "totalSize": 123
}

List API keys for the user named in user_id. Admins can pass - as user_id to list keys for all users and service accounts in the account (equivalent to firectl api-key list --all-users).

curl -s "https://api.fireworks.ai/v1/accounts/${ACCOUNT_ID}/users/-/apiKeys" \
  -H "Authorization: Bearer ${FIREWORKS_API_KEY}"

Authorizations

Authorization · string · header · required

Bearer authentication using your Fireworks API key. Format: Bearer <API_KEY>

Path Parameters

account_id · string · required

The Account Id

user_id · string · required

The User Id

Query Parameters

pageSize · integer<int32>

Number of API keys to return in the response. Pagination support to be added.

pageToken · string

Token for fetching the next page of results. Pagination support to be added.

filter · string

Field for filtering results.

orderBy · string

Field for ordering results.

readMask · string

The fields to be returned in the response. If empty or "*", all fields will be returned.

Response

200 - application/json

A successful response.

apiKeys · object[]

List of API keys retrieved.

Show child attributes

nextPageToken · string

totalSize · integer<int32>

The total number of API keys.