Update Consumer Profile

PATCH /v1/consumer-profiles/{uuid}

Update Consumer Profile

cURL

curl --request PATCH \
  --url https://api.dispersed.com/v1/consumer-profiles/{uuid} \
  --header 'Content-Type: application/json' \
  --data '
{
  "is_active": true,
  "is_compute_billing_enabled": true,
  "allowed_region_codes": [
    "us-west-2"
  ]
}
'

import requests

url = "https://api.dispersed.com/v1/consumer-profiles/{uuid}"

payload = {
    "is_active": True,
    "is_compute_billing_enabled": True,
    "allowed_region_codes": ["us-west-2"]
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    is_active: true,
    is_compute_billing_enabled: true,
    allowed_region_codes: ['us-west-2']
  })
};

fetch('https://api.dispersed.com/v1/consumer-profiles/{uuid}', 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.dispersed.com/v1/consumer-profiles/{uuid}",
  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([
    'is_active' => true,
    'is_compute_billing_enabled' => true,
    'allowed_region_codes' => [
        'us-west-2'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "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.dispersed.com/v1/consumer-profiles/{uuid}"

	payload := strings.NewReader("{\n  \"is_active\": true,\n  \"is_compute_billing_enabled\": true,\n  \"allowed_region_codes\": [\n    \"us-west-2\"\n  ]\n}")

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

	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.dispersed.com/v1/consumer-profiles/{uuid}")
  .header("Content-Type", "application/json")
  .body("{\n  \"is_active\": true,\n  \"is_compute_billing_enabled\": true,\n  \"allowed_region_codes\": [\n    \"us-west-2\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dispersed.com/v1/consumer-profiles/{uuid}")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"is_active\": true,\n  \"is_compute_billing_enabled\": true,\n  \"allowed_region_codes\": [\n    \"us-west-2\"\n  ]\n}"

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

200

{
  "is_active": true,
  "is_compute_billing_enabled": true,
  "object": "consumer_profile",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "account_uuid": "<string>",
  "render_user_id": "<string>",
  "allowed_region_codes": [],
  "deleted_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "timestamp": "<string>",
    "details": []
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "timestamp": "<string>",
    "details": []
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "timestamp": "<string>",
    "details": []
  }
}

Path Parameters

uuid · string<uuid> · required

Body

application/json

is_active · boolean

is_compute_billing_enabled · boolean

allowed_region_codes · enum<string>[]

Enforced region-code allowlist. When non-empty, jobs from this consumer are only assigned to nodes in these regions.

Maximum array length: 36

Available options: ca-central-1, ca-west-1, mx-central-1, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2, eu-central-1, eu-central-2, eu-north-1, eu-south-1, eu-south-2, eu-west-1, eu-west-2, eu-west-3, ap-east-1, ap-east-2, ap-northeast-1, ap-northeast-2, ap-northeast-3, ap-south-1, ap-south-2, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-4, ap-southeast-5, ap-southeast-6, ap-southeast-7, cn-north-1, cn-northwest-1, af-south-1, il-central-1, me-central-1, me-south-1

Example:

["us-west-2"]

Response

200

application/json

Consumer profile updated successfully

is_active · boolean · required

is_compute_billing_enabled · boolean · required

object · enum<string> · required

Available options: consumer_profile

created_at · string<date-time> | null · required

updated_at · string<date-time> | null · required

uuid · string | null

account_uuid · string | null

render_user_id · string | null

allowed_region_codes · (enum<string> | null)[]

Coarse geographic-network region identifier (AWS-style naming).

Available options: ca-central-1, ca-west-1, mx-central-1, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2, eu-central-1, eu-central-2, eu-north-1, eu-south-1, eu-south-2, eu-west-1, eu-west-2, eu-west-3, ap-east-1, ap-east-2, ap-northeast-1, ap-northeast-2, ap-northeast-3, ap-south-1, ap-south-2, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-4, ap-southeast-5, ap-southeast-6, ap-southeast-7, cn-north-1, cn-northwest-1, af-south-1, il-central-1, me-central-1, me-south-1, null

Example:

"us-west-2"

deleted_at · string<date-time> | null