Update an API path

Update a specific API path for a domain

PATCH /waap/v1/domains/{domain_id}/api-paths/{path_id}

Python

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
client.waap.domains.api_paths.update(
    path_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    domain_id=1,
)

400

{
  "type": "http-bad-request",
  "title": "Bad Request",
  "status": 400,
  "detail": "Invalid domain name: ''''"
}

Authorizations

Authorization · string · header · required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

domain_id · integer · required

The domain ID

path_id · string<uuid> · required

The path ID

Body

application/json

Request model for updating an API path

path · string

The updated API path. When updating the path, variables can be renamed, path parts can be converted to variables and vice versa.

Maximum string length: 1024

Example:

"/api/v1/paths/{path_id}"

tags · string[]

Maximum array length: 5

A user defined tag. Tags must start with a letter and can contain only letters, numbers and spaces.

Maximum string length: 50

Pattern: ^[a-zA-Z]+[ a-zA-Z0-9]*$

Example:

["sensitivedataurl", "highriskurl"]

api_groups · string[]

Example:

["accounts", "internal"]

status · enum<string>

The different statuses an API path can have

Available options: CONFIRMED_API, POTENTIAL_API, NOT_API, DELISTED_API

Response

204

Successful Response