PUT
/
project
/
{id}
/
share
/
policy
/
{policy_id}
cURL
curl --request PUT \
  --url https://api.chartbrew.com/project/{id}/share/policy/{policy_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "params": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "allow_params": false,
  "expires_at": "2023-11-07T05:31:56Z"
}'
{
  "id": 123,
  "entity_type": "Project",
  "entity_id": 123,
  "params": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "allow_params": false,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

ID of the project

policy_id
string
required

ID of the share policy

Body

application/json
params
object[]

Parameters to include in the share policy. Use this to pass parameters to the dashboard's variables.

allow_params
boolean
default:false

Whether to allow parameters to be passed via URL

expires_at
string<date-time>

Token expiration date and time

Response

Updated share policy

id
integer
entity_type
enum<string>
Available options:
Project,
Chart
entity_id
integer
params
object[]

Parameters to pass to variables in the dashboard's charts

allow_params
boolean
default:false

Whether to allow parameters to be passed via URL

createdAt
string<date-time>
updatedAt
string<date-time>