Update Key

curl --request PATCH \
  --url https://statsigapi.net/console/v1/keys/{id} \
  --header 'Content-Type: application/json' \
  --header 'STATSIG-API-KEY: <api-key>' \
  --data '
{
  "description": "<string>",
  "scopes": [],
  "environments": [
    "<string>"
  ],
  "targetAppID": "<string>",
  "secondaryTargetAppIDs": [
    "<string>"
  ]
}
'

import requests

url = "https://statsigapi.net/console/v1/keys/{id}"

payload = {
    "description": "<string>",
    "scopes": [],
    "environments": ["<string>"],
    "targetAppID": "<string>",
    "secondaryTargetAppIDs": ["<string>"]
}
headers = {
    "STATSIG-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'STATSIG-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: '<string>',
    scopes: [],
    environments: ['<string>'],
    targetAppID: '<string>',
    secondaryTargetAppIDs: ['<string>']
  })
};

fetch('https://statsigapi.net/console/v1/keys/{id}', 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://statsigapi.net/console/v1/keys/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => '<string>',
    'scopes' => [
        
    ],
    'environments' => [
        '<string>'
    ],
    'targetAppID' => '<string>',
    'secondaryTargetAppIDs' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "STATSIG-API-KEY: <api-key>"
  ],
]);

$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://statsigapi.net/console/v1/keys/{id}"

	payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"scopes\": [],\n  \"environments\": [\n    \"<string>\"\n  ],\n  \"targetAppID\": \"<string>\",\n  \"secondaryTargetAppIDs\": [\n    \"<string>\"\n  ]\n}")

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

	req.Header.Add("STATSIG-API-KEY", "<api-key>")
	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.patch("https://statsigapi.net/console/v1/keys/{id}")
  .header("STATSIG-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"scopes\": [],\n  \"environments\": [\n    \"<string>\"\n  ],\n  \"targetAppID\": \"<string>\",\n  \"secondaryTargetAppIDs\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://statsigapi.net/console/v1/keys/{id}")

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

request = Net::HTTP::Patch.new(url)
request["STATSIG-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\",\n  \"scopes\": [],\n  \"environments\": [\n    \"<string>\"\n  ],\n  \"targetAppID\": \"<string>\",\n  \"secondaryTargetAppIDs\": [\n    \"<string>\"\n  ]\n}"

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

{
  "message": "Key updated successfully.",
  "data": {
    "environments": [
      "staging"
    ],
    "targetAppID": "primaryApp",
    "secondaryTargetAppIDs": null
  }
}

{
  "status": 403,
  "message": "Forbidden. The request was valid, but the server is refusing action. You might not have the necessary permissions to access the resource."
}

{
  "status": 404,
  "message": "Not Found. The requested resource could not be found."
}

PATCH

console

keys

{id}

Update Key

curl --request PATCH \
  --url https://statsigapi.net/console/v1/keys/{id} \
  --header 'Content-Type: application/json' \
  --header 'STATSIG-API-KEY: <api-key>' \
  --data '
{
  "description": "<string>",
  "scopes": [],
  "environments": [
    "<string>"
  ],
  "targetAppID": "<string>",
  "secondaryTargetAppIDs": [
    "<string>"
  ]
}
'

import requests

url = "https://statsigapi.net/console/v1/keys/{id}"

payload = {
    "description": "<string>",
    "scopes": [],
    "environments": ["<string>"],
    "targetAppID": "<string>",
    "secondaryTargetAppIDs": ["<string>"]
}
headers = {
    "STATSIG-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'STATSIG-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: '<string>',
    scopes: [],
    environments: ['<string>'],
    targetAppID: '<string>',
    secondaryTargetAppIDs: ['<string>']
  })
};

fetch('https://statsigapi.net/console/v1/keys/{id}', 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://statsigapi.net/console/v1/keys/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => '<string>',
    'scopes' => [
        
    ],
    'environments' => [
        '<string>'
    ],
    'targetAppID' => '<string>',
    'secondaryTargetAppIDs' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "STATSIG-API-KEY: <api-key>"
  ],
]);

$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://statsigapi.net/console/v1/keys/{id}"

	payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"scopes\": [],\n  \"environments\": [\n    \"<string>\"\n  ],\n  \"targetAppID\": \"<string>\",\n  \"secondaryTargetAppIDs\": [\n    \"<string>\"\n  ]\n}")

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

	req.Header.Add("STATSIG-API-KEY", "<api-key>")
	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.patch("https://statsigapi.net/console/v1/keys/{id}")
  .header("STATSIG-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"scopes\": [],\n  \"environments\": [\n    \"<string>\"\n  ],\n  \"targetAppID\": \"<string>\",\n  \"secondaryTargetAppIDs\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://statsigapi.net/console/v1/keys/{id}")

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

request = Net::HTTP::Patch.new(url)
request["STATSIG-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\",\n  \"scopes\": [],\n  \"environments\": [\n    \"<string>\"\n  ],\n  \"targetAppID\": \"<string>\",\n  \"secondaryTargetAppIDs\": [\n    \"<string>\"\n  ]\n}"

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

{
  "message": "Key updated successfully.",
  "data": {
    "environments": [
      "staging"
    ],
    "targetAppID": "primaryApp",
    "secondaryTargetAppIDs": null
  }
}

{
  "status": 403,
  "message": "Forbidden. The request was valid, but the server is refusing action. You might not have the necessary permissions to access the resource."
}

{
  "status": 404,
  "message": "Not Found. The requested resource could not be found."
}

Authorizations

STATSIG-API-KEY

string

header

required

Headers

x-respect-review-settings

string

Optional header to respect review settings for mutation endpoints.

Path Parameters

string

required

Body

application/json

description

string

Maximum string length: 1000

scopes

enum<string>[]

Available options:

omni_read_only,

omni_read_write,

client_download_config_specs,

none_hash_enabled,

can_access_keys

environments

string[]

targetAppID

string | null

secondaryTargetAppIDs

string[] | null

Response

Key updated successfully

message

string

required

A simple string explaining the result of the operation.

data

object

required

A single result.

Show child attributes

⌘I

HTTP API

Console API

Alerts

Audit Logs

Autotunes

Company

Dynamic Configs

Events

Experiments

Experiments (Warehouse Native)

Configs

Gates

Holdouts

Ingestions

Keys

Layers

Metrics

Metrics (Warehouse Native)

Project

Usage

Reports

Segments

Tags

Target App

Users

Update Key

Authorizations

Headers

Path Parameters

Body

Response