Synchronizing Google Cloud Keys
Use the post /v1/cckm/google/synchronization-jobs
API to synchronize Google Cloud keys. Synchronize keys from either all or specified Google Cloud key rings.
Syntax
Request Parameters
Parameter | Type | Description |
---|---|---|
AUTHTOKEN | string | Authorization token. |
key_rings | array of strings | Name or ID of Google Cloud key rings from which keys will be synchronized. |
synchronize_all | boolean | Whether to synchronize all Google Cloud keys from all rings. Set to true to synchronize, otherwise, set to false . |
Note
synchronize_all
and key_rings
are mutually exclusive, specify either.
Example Request
Example Response
The sample output shows that overall_status
of key synchronization job with the ID "1f1d1b1b-a17c-486f-b864-db894af6efac"
of the Google Cloud key ring demo-key-ring
is in_progress
.
The ID of a synchronization job is required to view details of the job. Refer to Viewing Details of a Synchronization Job for details.
Response Codes
Response Code | Description |
---|---|
2xx | Success |
4xx | Client errors |
5xx | Server errors |
Refer to HTTP status codes for details.