organizations

Changed on

Creates a new PostureDeployment in a given project and location.

post/v1/{+parent}/postureDeployments

Request

  • Base URL: https://securityposture.googleapis.com
  • URL: https://securityposture.googleapis.com/v1/{+parent}/postureDeployments
  • Auth: OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/cloud-platform) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/cloud-platform)

Path parameters

parentstring required

Required. The parent resource name, in the format organizations/{organization}/locations/global.

Query parameters

postureDeploymentIdstring

Required. An identifier for the posture deployment.

Request body

annotationsobject

Optional. The user-specified annotations for the posture deployment. For details about the values you can use in an annotation, see AIP-148: Standard fields.

categoriesstring[]

Output only. The categories that the posture deployment belongs to, as determined by the Security Posture API.

createTimestring google-datetime

Output only. The time at which the posture deployment was created.

descriptionstring

Optional. A description of the posture deployment.

desiredPostureIdstring

Output only. The posture ID that was specified for the deployment. Present only if the posture deployment is in a failed state.

desiredPostureRevisionIdstring

Output only. The revision ID of the posture that was specified for the deployment. Present only if the deployment is in a failed state.

etagstring

Optional. An opaque identifier for the current version of the posture deployment. To prevent concurrent updates from overwriting each other, always provide the etag when you update a posture deployment. You can also provide the etag when you delete a posture deployment, to help ensure that you're deleting the intended posture deployment.

failureMessagestring

Output only. A description of why the posture deployment failed. Present only if the deployment is in a failed state.

namestring

Required. Identifier. The name of the posture deployment, in the format organizations/{organization}/locations/global/postureDeployments/{deployment_id}.

postureIdstring

Required. The posture used in the deployment, in the format organizations/{organization}/locations/global/postures/{posture_id}.

postureRevisionIdstring

Required. The revision ID of the posture used in the deployment.

reconcilingboolean

Output only. Whether the posture deployment is in the process of being updated.

state'STATE_UNSPECIFIED' | 'CREATING' | 'DELETING' | 'UPDATING' | 'ACTIVE' | 'CREATE_FAILED' | 'UPDATE_FAILED' | 'DELETE_FAILED'

Output only. The state of the posture deployment.

targetResourcestring

Required. The organization, folder, or project where the posture is deployed. Uses one of the following formats: * organizations/{organization_number} * folders/{folder_number} * projects/{project_number}

updateTimestring google-datetime

Output only. The time at which the posture deployment was last updated.

Response

Successful response

Changes

  • fe69852d49bcRevision changes
    • breaking

      removed the request body

    • breaking

      removed the media type */* for the response with the status