Gcm scans

Create gcm scan

POST
/organizations/{organizationId}/projects/{projectId}/gcm-scans

Start a new manual gcm scan for the current project or a custom domain (billed per domain scanned; the weekly auto-run is free).

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)$
Formatuuid
projectId*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)$
Formatuuid

Request 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/gcm-scans" \  -H "Content-Type: application/json" \  -d '{}'
{  "taskStarted": true,  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",  "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",  "domainsCount": 0}