Update Workspace Access

Updates workspace access permissions, usage limits, and rate limits for an integration. Can configure global workspace access or per-workspace settings.

PUT /integrations/{slug}/workspaces

Bulk update workspace access

cURL

curl --request PUT \
  --url https://api.portkey.ai/v1/integrations/{slug}/workspaces \
  --header 'Content-Type: application/json' \
  --header 'x-portkey-api-key: <api-key>' \
  --data '
{
  "workspaces": [
    {
      "id": "ws-my-team-1234",
      "enabled": true,
      "usage_limits": [
        {
          "credit_limit": 10,
          "periodic_reset": "monthly",
          "alert_threshold": 8
        }
      ],
      "rate_limits": [
        {
          "value": 123
        }
      ],
      "reset_usage": true
    }
  ],
  "override_existing_workspace_access": true
}
'

import requests

url = "https://api.portkey.ai/v1/integrations/{slug}/workspaces"

payload = {
    "workspaces": [
        {
            "id": "ws-my-team-1234",
            "enabled": True,
            "usage_limits": [
                {
                    "credit_limit": 10,
                    "periodic_reset": "monthly",
                    "alert_threshold": 8
                }
            ],
            "rate_limits": [{ "value": 123 }],
            "reset_usage": True
        }
    ],
    "override_existing_workspace_access": True
}
headers = {
    "x-portkey-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-portkey-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    workspaces: [
      {
        id: 'ws-my-team-1234',
        enabled: true,
        usage_limits: [{credit_limit: 10, periodic_reset: 'monthly', alert_threshold: 8}],
        rate_limits: [{value: 123}],
        reset_usage: true
      }
    ],
    override_existing_workspace_access: true
  })
};

fetch('https://api.portkey.ai/v1/integrations/{slug}/workspaces', 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.portkey.ai/v1/integrations/{slug}/workspaces",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'workspaces' => [
        [
                'id' => 'ws-my-team-1234',
                'enabled' => true,
                'usage_limits' => [
                                [
                                                                'credit_limit' => 10,
                                                                'periodic_reset' => 'monthly',
                                                                'alert_threshold' => 8
                                ]
                ],
                'rate_limits' => [
                                [
                                                                'value' => 123
                                ]
                ],
                'reset_usage' => true
        ]
    ],
    'override_existing_workspace_access' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-portkey-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://api.portkey.ai/v1/integrations/{slug}/workspaces"

	payload := strings.NewReader("{\n  \"workspaces\": [\n    {\n      \"id\": \"ws-my-team-1234\",\n      \"enabled\": true,\n      \"usage_limits\": [\n        {\n          \"credit_limit\": 10,\n          \"periodic_reset\": \"monthly\",\n          \"alert_threshold\": 8\n        }\n      ],\n      \"rate_limits\": [\n        {\n          \"value\": 123\n        }\n      ],\n      \"reset_usage\": true\n    }\n  ],\n  \"override_existing_workspace_access\": true\n}")

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

	req.Header.Add("x-portkey-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.put("https://api.portkey.ai/v1/integrations/{slug}/workspaces")
  .header("x-portkey-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspaces\": [\n    {\n      \"id\": \"ws-my-team-1234\",\n      \"enabled\": true,\n      \"usage_limits\": [\n        {\n          \"credit_limit\": 10,\n          \"periodic_reset\": \"monthly\",\n          \"alert_threshold\": 8\n        }\n      ],\n      \"rate_limits\": [\n        {\n          \"value\": 123\n        }\n      ],\n      \"reset_usage\": true\n    }\n  ],\n  \"override_existing_workspace_access\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.portkey.ai/v1/integrations/{slug}/workspaces")

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

request = Net::HTTP::Put.new(url)
request["x-portkey-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workspaces\": [\n    {\n      \"id\": \"ws-my-team-1234\",\n      \"enabled\": true,\n      \"usage_limits\": [\n        {\n          \"credit_limit\": 10,\n          \"periodic_reset\": \"monthly\",\n          \"alert_threshold\": 8\n        }\n      ],\n      \"rate_limits\": [\n        {\n          \"value\": 123\n        }\n      ],\n      \"reset_usage\": true\n    }\n  ],\n  \"override_existing_workspace_access\": true\n}"

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

200

{}

Authorizations

x-portkey-api-key · string · header · required

Path Parameters

slug · string · required

Body

application/json

workspaces · object[]

Show child attributes

global_workspace_access · object

Show child attributes

override_existing_workspace_access · boolean

Whether to override existing workspace access settings

Response

200 - application/json

Workspace access updated successfully

The response is of type object.