Compliance scans
Create compliance scan
Start a managed compliance scan for an authorized target (a registered project domain or a subdomain whose registrable parent matches one).
Authorization
ApiKeyAuth x-api-key<token>
In: header
Path Parameters
organizationId*string
Match
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Format
uuidprojectId*string
Match
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/compliance-scans" \ -H "Content-Type: application/json" \ -d '{ "target": "string" }'{ "taskStarted": true, "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8", "target": "string", "parentDomain": "string", "runs": [ { "jurisdictionCode": "string", "runId": "string", "taskStarted": true, "gatePassed": true } ]}