get
/api/v2/zones/custom/batches/{id}
Python SDK method:
client.zones.custom_zone_batch(id=job_id).results()

Get batch create results

Returns paginated per-zone results for a completed custom zone batch job. Each row reports the outcome of a single zone, including any validation errors. Serves batches started inline and those started from an uploaded file import.

Input Parameters

NameLocationTypeValuesDescriptionValue Required
idpathstring-The id of the job whose results you want to fetch.Y
pageTokenquerystring-Pagination token returned in the Link header of a previous response. Omit to fetch the first page.N

Success Responses

200 response: object

Paginated result data. When more pages are available, a Link: rel="next" header and Altitude-* pagination headers are included in the response.

NameTypeDescription
commentsstringNotes about the zone, if provided in the uploaded file.
customerZoneIdstringCustomer-defined external identifier for the zone, if provided in the uploaded file.
errorsarray<string>Validation or processing errors for this zone. Empty when the zone imported successfully.
geographystringGeoJSON geometry string for the zone.
statusinteger (int64)Outcome status for this zone: 1 = created, 0 = failed.
zoneIdstringIdentifier of the created custom zone. Empty if the zone failed to import.
zoneNamestringDisplay name of the zone from the uploaded file.

Response Errors

HTTP Status CodeReason
400The request body or parameters are invalid.
401Authentication is required or the provided credentials are invalid.
403The authenticated user lacks permission to perform this operation.
404The requested resource does not exist.
409Result not yet ready. Poll the status monitor.
429The request rate limit has been exceeded.
500An unexpected server error occurred.