Update Policy Settings

Updates the per-account PolicySettings singleton.

curl --request PATCH \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/policySettings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rules": [
    {
      "model": "<string>",
      "permissions": {
        "allowServerless": true,
        "allowDedicatedDeployments": true,
        "allowTraining": true,
        "allowServerlessFast": true
      }
    }
  ],
  "cmekRequired": true,
  "residency": "MULTI_REGION_UNSPECIFIED"
}
'

import requests

url = "https://api.fireworks.ai/v1/accounts/{account_id}/policySettings"

payload = {
    "rules": [
        {
            "model": "<string>",
            "permissions": {
                "allowServerless": True,
                "allowDedicatedDeployments": True,
                "allowTraining": True,
                "allowServerlessFast": True
            }
        }
    ],
    "cmekRequired": True,
    "residency": "MULTI_REGION_UNSPECIFIED"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    rules: [
      {
        model: '<string>',
        permissions: {
          allowServerless: true,
          allowDedicatedDeployments: true,
          allowTraining: true,
          allowServerlessFast: true
        }
      }
    ],
    cmekRequired: true,
    residency: 'MULTI_REGION_UNSPECIFIED'
  })
};

fetch('https://api.fireworks.ai/v1/accounts/{account_id}/policySettings', 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}/policySettings",
  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([
    'rules' => [
        [
                'model' => '<string>',
                'permissions' => [
                                'allowServerless' => true,
                                'allowDedicatedDeployments' => true,
                                'allowTraining' => true,
                                'allowServerlessFast' => true
                ]
        ]
    ],
    'cmekRequired' => true,
    'residency' => 'MULTI_REGION_UNSPECIFIED'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.fireworks.ai/v1/accounts/{account_id}/policySettings"

	payload := strings.NewReader("{\n  \"rules\": [\n    {\n      \"model\": \"<string>\",\n      \"permissions\": {\n        \"allowServerless\": true,\n        \"allowDedicatedDeployments\": true,\n        \"allowTraining\": true,\n        \"allowServerlessFast\": true\n      }\n    }\n  ],\n  \"cmekRequired\": true,\n  \"residency\": \"MULTI_REGION_UNSPECIFIED\"\n}")

	req, _ := http.NewRequest("PATCH", 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(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.fireworks.ai/v1/accounts/{account_id}/policySettings")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"rules\": [\n    {\n      \"model\": \"<string>\",\n      \"permissions\": {\n        \"allowServerless\": true,\n        \"allowDedicatedDeployments\": true,\n        \"allowTraining\": true,\n        \"allowServerlessFast\": true\n      }\n    }\n  ],\n  \"cmekRequired\": true,\n  \"residency\": \"MULTI_REGION_UNSPECIFIED\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"rules\": [\n    {\n      \"model\": \"<string>\",\n      \"permissions\": {\n        \"allowServerless\": true,\n        \"allowDedicatedDeployments\": true,\n        \"allowTraining\": true,\n        \"allowServerlessFast\": true\n      }\n    }\n  ],\n  \"cmekRequired\": true,\n  \"residency\": \"MULTI_REGION_UNSPECIFIED\"\n}"

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

{
  "name": "<string>",
  "defaultPermissions": {
    "allowServerless": true,
    "allowDedicatedDeployments": true,
    "allowTraining": true,
    "allowServerlessFast": true
  },
  "rules": [
    {
      "model": "<string>",
      "permissions": {
        "allowServerless": true,
        "allowDedicatedDeployments": true,
        "allowTraining": true,
        "allowServerlessFast": true
      }
    }
  ],
  "updateTime": "2023-11-07T05:31:56Z",
  "cmekRequired": true,
  "residency": "MULTI_REGION_UNSPECIFIED",
  "zeroDataRetention": {
    "defaultEnforced": true,
    "inference": {
      "enforcement": "ENFORCEMENT_UNSPECIFIED"
    },
    "training": {
      "enforcement": "ENFORCEMENT_UNSPECIFIED"
    }
  }
}

PATCH

accounts

{account_id}

policySettings

Updates the per-account PolicySettings singleton.

curl --request PATCH \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/policySettings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rules": [
    {
      "model": "<string>",
      "permissions": {
        "allowServerless": true,
        "allowDedicatedDeployments": true,
        "allowTraining": true,
        "allowServerlessFast": true
      }
    }
  ],
  "cmekRequired": true,
  "residency": "MULTI_REGION_UNSPECIFIED"
}
'

import requests

url = "https://api.fireworks.ai/v1/accounts/{account_id}/policySettings"

payload = {
    "rules": [
        {
            "model": "<string>",
            "permissions": {
                "allowServerless": True,
                "allowDedicatedDeployments": True,
                "allowTraining": True,
                "allowServerlessFast": True
            }
        }
    ],
    "cmekRequired": True,
    "residency": "MULTI_REGION_UNSPECIFIED"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    rules: [
      {
        model: '<string>',
        permissions: {
          allowServerless: true,
          allowDedicatedDeployments: true,
          allowTraining: true,
          allowServerlessFast: true
        }
      }
    ],
    cmekRequired: true,
    residency: 'MULTI_REGION_UNSPECIFIED'
  })
};

fetch('https://api.fireworks.ai/v1/accounts/{account_id}/policySettings', 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}/policySettings",
  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([
    'rules' => [
        [
                'model' => '<string>',
                'permissions' => [
                                'allowServerless' => true,
                                'allowDedicatedDeployments' => true,
                                'allowTraining' => true,
                                'allowServerlessFast' => true
                ]
        ]
    ],
    'cmekRequired' => true,
    'residency' => 'MULTI_REGION_UNSPECIFIED'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.fireworks.ai/v1/accounts/{account_id}/policySettings"

	payload := strings.NewReader("{\n  \"rules\": [\n    {\n      \"model\": \"<string>\",\n      \"permissions\": {\n        \"allowServerless\": true,\n        \"allowDedicatedDeployments\": true,\n        \"allowTraining\": true,\n        \"allowServerlessFast\": true\n      }\n    }\n  ],\n  \"cmekRequired\": true,\n  \"residency\": \"MULTI_REGION_UNSPECIFIED\"\n}")

	req, _ := http.NewRequest("PATCH", 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(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.fireworks.ai/v1/accounts/{account_id}/policySettings")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"rules\": [\n    {\n      \"model\": \"<string>\",\n      \"permissions\": {\n        \"allowServerless\": true,\n        \"allowDedicatedDeployments\": true,\n        \"allowTraining\": true,\n        \"allowServerlessFast\": true\n      }\n    }\n  ],\n  \"cmekRequired\": true,\n  \"residency\": \"MULTI_REGION_UNSPECIFIED\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"rules\": [\n    {\n      \"model\": \"<string>\",\n      \"permissions\": {\n        \"allowServerless\": true,\n        \"allowDedicatedDeployments\": true,\n        \"allowTraining\": true,\n        \"allowServerlessFast\": true\n      }\n    }\n  ],\n  \"cmekRequired\": true,\n  \"residency\": \"MULTI_REGION_UNSPECIFIED\"\n}"

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

{
  "name": "<string>",
  "defaultPermissions": {
    "allowServerless": true,
    "allowDedicatedDeployments": true,
    "allowTraining": true,
    "allowServerlessFast": true
  },
  "rules": [
    {
      "model": "<string>",
      "permissions": {
        "allowServerless": true,
        "allowDedicatedDeployments": true,
        "allowTraining": true,
        "allowServerlessFast": true
      }
    }
  ],
  "updateTime": "2023-11-07T05:31:56Z",
  "cmekRequired": true,
  "residency": "MULTI_REGION_UNSPECIFIED",
  "zeroDataRetention": {
    "defaultEnforced": true,
    "inference": {
      "enforcement": "ENFORCEMENT_UNSPECIFIED"
    },
    "training": {
      "enforcement": "ENFORCEMENT_UNSPECIFIED"
    }
  }
}

Updates the account’s governance settings. The API key must belong to an account Admin on an Enterprise account, either a user or a service account with the Admin role. Requests with any other key fail with a permission error. Pass updateMask with the proto field names of the settings you are changing, comma-separated. If you omit it, the mask is derived from the fields present in your request body. Settings outside the mask are left unchanged.

Setting	`updateMask`	Notes
Model access policy	`default_permissions`, `rules`	`rules` replaces the whole list. Every permissions object needs all four booleans.
Data residency	`residency`	Accepts `US`. Mask `residency` and omit the field to remove the restriction.
Zero Data Retention policy	`zero_data_retention`	Replaces the whole section, so always send `defaultEnforced`. A scope you leave out follows `defaultEnforced`.
Customer-managed encryption keys	`cmek_required`	Only Fireworks can change it.

curl -X PATCH \
  "https://api.fireworks.ai/v1/accounts/${ACCOUNT_ID}/policySettings?updateMask=zero_data_retention" \
  -H "Authorization: Bearer ${FIREWORKS_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"zeroDataRetention": {"defaultEnforced": true}}'

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

Body

application/json

The policy settings to update. policy_settings.name must be populated. Format: accounts/{account}/policySettings

defaultPermissions

object

Per-account default permissions. If unset, defaults to allow-all. This powers the UI's "Default" row.

Show child attributes

rules

object[]

Per-model override rows. A model not listed here uses default_permissions.

Show child attributes

cmekRequired

boolean

Whether new customer-data resources for this account must be CMEK-encrypted. Readable by the account, but only a Fireworks superuser can change it (the write path gates this explicitly). Enabling requires a READY primary ExternalKey.

residency

enum<string>

default:MULTI_REGION_UNSPECIFIED

Restricts serving to one geography when set. An absent value leaves the account unrestricted.

Available options:

MULTI_REGION_UNSPECIFIED,

GLOBAL,

US,

CANADA,

EUROPE,

APAC

zeroDataRetention

object

Zero Data Retention policy for the account. When absent, ZDR is not enforced. Independent of model access permissions and CMEK.

Show child attributes

Response

200 - application/json

A successful response.

Account-level policy settings (singleton per account). Holds model access and may grow with other policy sections (e.g. regional residency) without separate top-level API resources.

name

string

read-only

defaultPermissions

object

Per-account default permissions. If unset, defaults to allow-all. This powers the UI's "Default" row.

Show child attributes

rules

object[]

Per-model override rows. A model not listed here uses default_permissions.

Show child attributes

updateTime

string<date-time>

read-only

cmekRequired

boolean

residency

enum<string>

default:MULTI_REGION_UNSPECIFIED

Restricts serving to one geography when set. An absent value leaves the account unrestricted.

Available options:

MULTI_REGION_UNSPECIFIED,

GLOBAL,

US,

CANADA,

EUROPE,

APAC

zeroDataRetention

object

Zero Data Retention policy for the account. When absent, ZDR is not enforced. Independent of model access permissions and CMEK.

Show child attributes

⌘I

API Reference

Inference

Deployments

Training

Training SDK

Evals

Admin

Authorizations

Path Parameters

Body

Response