Settings

Manage organization-wide Stook configuration — such as IP restrictions, rate limits, and CORS settings.

Retrieve settings

get

Authorizations

Bearer

Path parameters

organization_uuidstringRequired

The UUID of the organization

Responses

200

Settings retrieved successfully

application/json

get

HTTPcURLJavaScriptPython

GET /api/api/v3/stook/{organization_uuid}/settings HTTP/1.1
Host: cloud.medianova.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Settings retrieved successfully

{
  "status": true,
  "data": {
    "eu-ist-1": {
      "uuid": "text",
      "name": "text",
      "status": true,
      "is_ip_restriction": true,
      "restriction_type": "allow",
      "ip_list": {
        "allow_ip_list": [
          "text"
        ],
        "deny_ip_list": [
          "text"
        ]
      },
      "is_rate_limit": true,
      "rate_limit_parameters": {
        "zone_size": 1,
        "request_count": 1,
        "request_type": "text",
        "burst": 1,
        "source": "text",
        "source_query_string": "text"
      },
      "status_cors_header": "on",
      "cors_domains": [
        "text"
      ],
      "options_request": true,
      "status_head_request_disallow": true,
      "location": "text",
      "domain_id": "text"
    },
    "eu-ank-1": {
      "uuid": "text",
      "name": "text",
      "status": true,
      "is_ip_restriction": true,
      "restriction_type": "allow",
      "ip_list": {
        "allow_ip_list": [
          "text"
        ],
        "deny_ip_list": [
          "text"
        ]
      },
      "is_rate_limit": true,
      "rate_limit_parameters": {
        "zone_size": 1,
        "request_count": 1,
        "request_type": "text",
        "burst": 1,
        "source": "text",
        "source_query_string": "text"
      },
      "status_cors_header": "on",
      "cors_domains": [
        "text"
      ],
      "options_request": true,
      "status_head_request_disallow": true,
      "location": "text",
      "domain_id": "text"
    }
  }
}

Update settings

put

Authorizations

Bearer

Path parameters

organization_uuidstringRequired

The UUID of the organization

settings_uuidstringRequired

The UUID of the settings record to update

Body

application/json

statusbooleanOptional

Enable or disable the domain configuration

is_ip_restrictionbooleanOptional

Enable or disable IP restriction

restriction_typestring · enumOptional

Type of IP restriction

Possible values:

is_rate_limitbooleanOptional

Enable or disable rate limiting

status_cors_headerstring · enumOptional

Status of CORS header

Possible values:

cors_domainsstring[]Optional

List of allowed CORS domains

options_requestbooleanOptional

Indicates if OPTIONS requests are allowed

status_head_request_disallowbooleanOptional

Indicates if HEAD requests should be disallowed

Responses

200

Settings successfully updated

application/json

put

HTTPcURLJavaScriptPython

PUT /api/api/v3/stook/{organization_uuid}/settings HTTP/1.1
Host: cloud.medianova.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 345

{
  "status": true,
  "is_ip_restriction": true,
  "restriction_type": "allow",
  "ip_list": {
    "allow_ip_list": [
      "text"
    ],
    "deny_ip_list": [
      "text"
    ]
  },
  "is_rate_limit": true,
  "rate_limit_parameters": {
    "zone_size": 1,
    "request_count": 1,
    "request_type": "m",
    "burst": 1
  },
  "status_cors_header": "on",
  "cors_domains": [
    "text"
  ],
  "options_request": true,
  "status_head_request_disallow": true
}

200

Settings successfully updated

{
  "status": true,
  "data": {
    "ANY_ADDITIONAL_PROPERTY": {
      "uuid": "text",
      "name": "text",
      "status": true,
      "is_ip_restriction": true,
      "restriction_type": "allow",
      "ip_list": {
        "allow_ip_list": [
          "text"
        ],
        "deny_ip_list": [
          "text"
        ]
      },
      "is_rate_limit": true,
      "rate_limit_parameters": {
        "zone_size": 1,
        "request_count": 1,
        "request_type": "text",
        "burst": 1,
        "source": "text",
        "source_query_string": "text"
      },
      "status_cors_header": "on",
      "cors_domains": [
        "text"
      ],
      "options_request": true,
      "status_head_request_disallow": true,
      "location": "text",
      "domain_id": "text"
    }
  }
}