resources.configureAccess

POST

/resources/{resourceId}/access-profile

curl --request POST \
  --url https://example.com/api/resources/example/access-profile \
  --header 'Content-Type: application/json' \
  --data '{ "accessProfile": { "generatedAccessMode": "inherit", "pathPrefix": "/" } }'

Configures resource participation in generated default access route planning. Public docs: /docs/access/generated-routes/#resource-access-profile

Parameters

Path Parameters

resourceId

required

string

>= 1 characters

Request Body ^required

Media type application/json

object

accessProfile

required

object

generatedAccessMode

string

default: inherit

Allowed values: inherit disabled

pathPrefix

string

default: / >= 1 characters

Responses

200

OK

Media type application/json

object

id

required

string

Example ^generated

{
  "id": "example"
}