v2

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-07-21130282381.6 KB
APIs

Verify HTTP API paths

Verify HTTP API paths

Verify paths before creating or updating a HTTP API.<br> This will check paths and hosts (depending on environment domain restrictions), and will check that path is not already used by other APIs in the environment.<br> The result will indicate if the paths are OK, and give the reason of the failure if they are not (path contains invalid chars, path is already covered by another API,...)

post/environments/{envId}/apis/_verify/paths

Path parameters

envIdstring required

Id or Hrid (Human readable Id) of an environment.

Request body

apiIdstring

Response

Result of the API paths verification

okboolean

Indicates whether the paths are valid.

reasonstring

An optional reason giving details about the result.