Security Command Center API (securitycenter:v1)

2023-07-25

18 new methods

Additions

    Methods
  • securitycenter.organizations.eventThreatDetectionSettings.customModules.create

      Flat Path : v1/organizations/{organizationsId}/eventThreatDetectionSettings/customModules

      Parameters :

        parent

          Required : Yes

          Type : string

          Location : path

          Pattern : ^organizations/[^/]+/eventThreatDetectionSettings$

          Description : Required. The new custom module's parent. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".

      Path : v1/{+parent}/customModules

      Parameter Order : parent

      Description : Creates an ETD custom module at the given level. Creating a module has a side-effect of creating modules at all descendants.

      Scopes : https://www.googleapis.com/auth/cloud-platform

      HTTP Method : POST

  • securitycenter.organizations.eventThreatDetectionSettings.customModules.delete

      Parameters :

        name

          Location : path

          Pattern : ^organizations/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$

          Description : Required. Name of the custom module to delete. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".

          Type : string

          Required : Yes

      Path : v1/{+name}

      Parameter Order : name

      Description : Deletes an ETD custom module. Deletion at resident level also deletes modules at all descendants. Deletion at any other level is not supported.

      HTTP Method : DELETE

      Flat Path : v1/organizations/{organizationsId}/eventThreatDetectionSettings/customModules/{customModulesId}

      Scopes : https://www.googleapis.com/auth/cloud-platform

  • securitycenter.organizations.eventThreatDetectionSettings.customModules.get

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Gets an ETD custom module. Retrieves the module at the given level.

      Path : v1/{+name}

      Parameters :

        name

          Pattern : ^organizations/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$

          Location : path

          Description : Required. Name of the custom module to get. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".

          Required : Yes

          Type : string

      Flat Path : v1/organizations/{organizationsId}/eventThreatDetectionSettings/customModules/{customModulesId}

      HTTP Method : GET

      Parameter Order : name

  • securitycenter.organizations.eventThreatDetectionSettings.customModules.list

      Description : Lists ETD custom modules. Retrieve all resident and inherited modules at the given level (no descendants).

      Path : v1/{+parent}/customModules

      Parameter Order : parent

      Flat Path : v1/organizations/{organizationsId}/eventThreatDetectionSettings/customModules

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameters :

        parent

          Pattern : ^organizations/[^/]+/eventThreatDetectionSettings$

          Type : string

          Description : Required. Name of the parent to list custom modules. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".

          Required : Yes

          Location : path

        pageToken

          Type : string

          Description : A page token, received from a previous `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventThreatDetectionCustomModules` must match the call that provided the page token.

          Location : query

        pageSize

          Format : int32

          Description : The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

          Location : query

          Type : integer

      HTTP Method : GET

  • securitycenter.organizations.eventThreatDetectionSettings.customModules.patch

      Description : Updates an ETD custom module at the given level. All config fields can be updated when updating the module at resident level. Only enablement state can be updated when updating the module at inherited levels. Updating the module has a side-effect that it updates all descendants that are inherited from this module.

      Parameter Order : name

      Flat Path : v1/organizations/{organizationsId}/eventThreatDetectionSettings/customModules/{customModulesId}

      HTTP Method : PATCH

      Parameters :

        name

          Type : string

          Required : Yes

          Pattern : ^organizations/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$

          Description : Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".

          Location : path

        updateMask

          Type : string

          Location : query

          Format : google-fieldmask

          Description : The list of fields to be updated. If empty all mutable fields will be updated.

      Path : v1/{+name}

      Scopes : https://www.googleapis.com/auth/cloud-platform

  • securitycenter.organizations.eventThreatDetectionSettings.validateCustomModule

      HTTP Method : POST

      Description : Validates the given Event Threat Detection Custom Module.

      Path : v1/{+parent}:validateCustomModule

      Flat Path : v1/organizations/{organizationsId}/eventThreatDetectionSettings:validateCustomModule

      Parameters :

        parent

          Pattern : ^organizations/[^/]+/eventThreatDetectionSettings$

          Required : Yes

          Type : string

          Description : Required. Resource name of the parent to validate the Custom Module under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".

          Location : path

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameter Order : parent

  • securitycenter.projects.eventThreatDetectionSettings.validateCustomModule

      Parameter Order : parent

      Parameters :

        parent

          Description : Required. Resource name of the parent to validate the Custom Module under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".

          Required : Yes

          Type : string

          Location : path

          Pattern : ^projects/[^/]+/eventThreatDetectionSettings$

      Path : v1/{+parent}:validateCustomModule

      HTTP Method : POST

      Flat Path : v1/projects/{projectsId}/eventThreatDetectionSettings:validateCustomModule

      Description : Validates the given Event Threat Detection Custom Module.

      Scopes : https://www.googleapis.com/auth/cloud-platform

  • securitycenter.projects.eventThreatDetectionSettings.customModules.patch

      Path : v1/{+name}

      Parameter Order : name

      Parameters :

        name

          Location : path

          Type : string

          Pattern : ^projects/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$

          Description : Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".

          Required : Yes

        updateMask

          Location : query

          Description : The list of fields to be updated. If empty all mutable fields will be updated.

          Type : string

          Format : google-fieldmask

      Description : Updates an ETD custom module at the given level. All config fields can be updated when updating the module at resident level. Only enablement state can be updated when updating the module at inherited levels. Updating the module has a side-effect that it updates all descendants that are inherited from this module.

      HTTP Method : PATCH

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Flat Path : v1/projects/{projectsId}/eventThreatDetectionSettings/customModules/{customModulesId}

  • securitycenter.projects.eventThreatDetectionSettings.customModules.create

      Path : v1/{+parent}/customModules

      Parameters :

        parent

          Description : Required. The new custom module's parent. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".

          Type : string

          Location : path

          Pattern : ^projects/[^/]+/eventThreatDetectionSettings$

          Required : Yes

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Flat Path : v1/projects/{projectsId}/eventThreatDetectionSettings/customModules

      HTTP Method : POST

      Description : Creates an ETD custom module at the given level. Creating a module has a side-effect of creating modules at all descendants.

      Parameter Order : parent

  • securitycenter.projects.eventThreatDetectionSettings.customModules.delete

      Scopes : https://www.googleapis.com/auth/cloud-platform

      HTTP Method : DELETE

      Path : v1/{+name}

      Parameter Order : name

      Flat Path : v1/projects/{projectsId}/eventThreatDetectionSettings/customModules/{customModulesId}

      Parameters :

        name

          Location : path

          Type : string

          Required : Yes

          Description : Required. Name of the custom module to delete. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".

          Pattern : ^projects/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$

      Description : Deletes an ETD custom module. Deletion at resident level also deletes modules at all descendants. Deletion at any other level is not supported.

  • securitycenter.projects.eventThreatDetectionSettings.customModules.list

      Flat Path : v1/projects/{projectsId}/eventThreatDetectionSettings/customModules

      HTTP Method : GET

      Parameter Order : parent

      Description : Lists ETD custom modules. Retrieve all resident and inherited modules at the given level (no descendants).

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Path : v1/{+parent}/customModules

      Parameters :

        parent

          Type : string

          Required : Yes

          Location : path

          Pattern : ^projects/[^/]+/eventThreatDetectionSettings$

          Description : Required. Name of the parent to list custom modules. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".

        pageToken

          Location : query

          Type : string

          Description : A page token, received from a previous `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventThreatDetectionCustomModules` must match the call that provided the page token.

        pageSize

          Description : The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

          Location : query

          Type : integer

          Format : int32

  • securitycenter.projects.eventThreatDetectionSettings.customModules.get

      Flat Path : v1/projects/{projectsId}/eventThreatDetectionSettings/customModules/{customModulesId}

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Path : v1/{+name}

      Parameter Order : name

      Parameters :

        name

          Required : Yes

          Pattern : ^projects/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$

          Description : Required. Name of the custom module to get. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".

          Location : path

          Type : string

      Description : Gets an ETD custom module. Retrieves the module at the given level.

      HTTP Method : GET

  • securitycenter.folders.eventThreatDetectionSettings.customModules.patch

      Scopes : https://www.googleapis.com/auth/cloud-platform

      HTTP Method : PATCH

      Flat Path : v1/folders/{foldersId}/eventThreatDetectionSettings/customModules/{customModulesId}

      Path : v1/{+name}

      Description : Updates an ETD custom module at the given level. All config fields can be updated when updating the module at resident level. Only enablement state can be updated when updating the module at inherited levels. Updating the module has a side-effect that it updates all descendants that are inherited from this module.

      Parameters :

        name

          Required : Yes

          Description : Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".

          Location : path

          Type : string

          Pattern : ^folders/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$

        updateMask

          Location : query

          Type : string

          Description : The list of fields to be updated. If empty all mutable fields will be updated.

          Format : google-fieldmask

      Parameter Order : name

  • securitycenter.folders.eventThreatDetectionSettings.customModules.get

      Parameter Order : name

      Path : v1/{+name}

      HTTP Method : GET

      Parameters :

        name

          Type : string

          Location : path

          Required : Yes

          Description : Required. Name of the custom module to get. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".

          Pattern : ^folders/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$

      Description : Gets an ETD custom module. Retrieves the module at the given level.

      Flat Path : v1/folders/{foldersId}/eventThreatDetectionSettings/customModules/{customModulesId}

      Scopes : https://www.googleapis.com/auth/cloud-platform

  • securitycenter.folders.eventThreatDetectionSettings.customModules.list

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameter Order : parent

      Flat Path : v1/folders/{foldersId}/eventThreatDetectionSettings/customModules

      Description : Lists ETD custom modules. Retrieve all resident and inherited modules at the given level (no descendants).

      HTTP Method : GET

      Parameters :

        pageToken

          Location : query

          Type : string

          Description : A page token, received from a previous `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventThreatDetectionCustomModules` must match the call that provided the page token.

        parent

          Description : Required. Name of the parent to list custom modules. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".

          Required : Yes

          Pattern : ^folders/[^/]+/eventThreatDetectionSettings$

          Type : string

          Location : path

        pageSize

          Type : integer

          Format : int32

          Location : query

          Description : The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

      Path : v1/{+parent}/customModules

  • securitycenter.folders.eventThreatDetectionSettings.customModules.delete

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Path : v1/{+name}

      Description : Deletes an ETD custom module. Deletion at resident level also deletes modules at all descendants. Deletion at any other level is not supported.

      Parameters :

        name

          Type : string

          Location : path

          Description : Required. Name of the custom module to delete. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".

          Required : Yes

          Pattern : ^folders/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$

      Parameter Order : name

      HTTP Method : DELETE

      Flat Path : v1/folders/{foldersId}/eventThreatDetectionSettings/customModules/{customModulesId}

  • securitycenter.folders.eventThreatDetectionSettings.customModules.create

      HTTP Method : POST

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameters :

        parent

          Pattern : ^folders/[^/]+/eventThreatDetectionSettings$

          Location : path

          Type : string

          Required : Yes

          Description : Required. The new custom module's parent. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".

      Path : v1/{+parent}/customModules

      Flat Path : v1/folders/{foldersId}/eventThreatDetectionSettings/customModules

      Description : Creates an ETD custom module at the given level. Creating a module has a side-effect of creating modules at all descendants.

      Parameter Order : parent

  • securitycenter.folders.eventThreatDetectionSettings.validateCustomModule

      Description : Validates the given Event Threat Detection Custom Module.

      Parameters :

        parent

          Type : string

          Description : Required. Resource name of the parent to validate the Custom Module under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".

          Required : Yes

          Location : path

          Pattern : ^folders/[^/]+/eventThreatDetectionSettings$

      Flat Path : v1/folders/{foldersId}/eventThreatDetectionSettings:validateCustomModule

      Parameter Order : parent

      HTTP Method : POST

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Path : v1/{+parent}:validateCustomModule