PRprobely
Schema Generation

Link or Unlink Generated Schema

Changed on

Link a generated schema to the target for DAST scanning (is_linked: true) or unlink it (is_linked: false). Linking atomically unlinks any sibling and materializes the schema file; unlinking clears the target's linked-schema configuration. Idempotent.

patch/targets/{target_id}/generated-schemas/{id}/

Request

  • Base URL
    https://api.probely.com
  • URL
    https://api.probely.com/targets/{target_id}/generated-schemas/{id}/
  • Auth
    API key in header Authorization

Path parameters

idstring required
target_idstring required

Identifier of the target.

Request body

is_linkedboolean

Response

schema_idstring required
namestring required
format'openapi' | 'graphql' required
  • openapi - OpenAPI
  • graphql - GraphQL
versionstring required
descriptionstring required
endpoints_countinteger required
confidence_scorestring decimal nullable required
base_urlstring nullable required
snyk_project_idstring required
snyk_project_namestring nullable required
branchstring required
source'in_repo' | 'llm' required
  • in_repo - Found in Repository
  • llm - LLM Generated
warningsunknown required
is_linkedboolean required
created_atstring date-time required

Changes