ESescape
Profiles

Update profile schema

This route is deprecated. Use PUT /profiles/:profileId with extraAssetIds instead.

Update the schema used to scan this profile. The schema ID is the ID of a schema uploaded to the Escape Platform using the POST /assets/schema endpoint.

Migration: send extraAssetIds on PUT /profiles/:profileId with every schema asset ID to link (one or more). Example: { "extraAssetIds": ["<schema-asset-id-1>", "<schema-asset-id-2>"] }.

put/profiles/{profileId}/schema

Request

  • Base URL
    https://public.escape.tech/v3
  • Auth
    API key in header X-ESCAPE-API-KEY

Path parameters

profileIdstring required

The profile ID

Example:00000000-0000-0000-0000-000000000000

Request body

schemaIdstring required

Deprecated: use extraAssetIds on PUT /profiles/:profileId instead. Single schema asset ID to link to the profile.

Example request

{
  "schemaId": "00000000-0000-0000-0000-000000000000"
}

Response

OK

idstring uuid required

The id of the profile

namestring required

The name of the profile

descriptionstring required

The description of the profile

scannerKindstring required

The scanner kind of the profile

createdAtstring required

The date and time the profile was created

updatedAtstring required

The date and time the profile was updated

cronstring nullable required

Deprecated: use schedule.cron instead.

scheduledForDeletionAtstring nullable required

The date and time the profile is scheduled for deletion

scorenumber nullable required

The score of the profile

coveragenumber nullable required

The coverage of the profile

maxDurationMinutesinteger nullable required

Maximum scan duration in minutes.

schemaAssetIdstring uuid nullable required

Schema asset id derived from the first extraAssets entry with class SCHEMA, a request hint when the link is not yet visible in extraAssets (e.g. immediately after a mutation), or the legacy assetSchemaId while migration/backfill is incomplete.

lastScanIdstring uuid nullable required

The ID of the last scan of the profile

lastSuccessfulScanIdstring uuid nullable required

The ID of the last successful scan of the profile

risksstring[] required

The risks of the profile

Example response

{
  "maxDurationMinutes": 240
}

Changes

No recorded changes to this operation across all 1 revision of this API.