2023-09-29
▼ ▲ apigee.organizations.environments.addonsConfig.setAddonEnablement
HTTP Method : POST
Description : Updates an add-on enablement status of an environment.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : Required. Name of the add-ons config. Must be in the format of `/organizations/{org}/environments/{env}/addonsConfig`
Location : path
Pattern : ^organizations/[^/]+/environments/[^/]+/addonsConfig$
Required : Yes
Type : string
Path : v1/{+name}:setAddonEnablement
Flat Path : v1/organizations/{organizationsId}/environments/{environmentsId}/addonsConfig:setAddonEnablement
Parameter Order : name
▼ ▲ apigee.organizations.environments.securityActions.list
Path : v1/{+parent}/securityActions
Parameter Order : parent
Flat Path : v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Returns a list of SecurityActions. This returns both enabled and disabled actions.
Parameters :
pageToken
Type : string
Location : query
Description : A page token, received from a previous `ListSecurityActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSecurityActions` must match the call that provided the page token.
parent
Description : Required. The parent, which owns this collection of SecurityActions. Format: organizations/{org}/environments/{env}
Location : path
Required : Yes
Type : string
Pattern : ^organizations/[^/]+/environments/[^/]+$
filter
Location : query
Type : string
Description : The filter expression to filter List results. https://google.aip.dev/160. Allows for filtering over: state and api_proxies. E.g.: state = ACTIVE AND apiProxies:foo. Filtering by action is not supported https://github.com/aip-dev/google.aip.dev/issues/624
pageSize
Type : integer
Format : int32
Location : query
Description : The maximum number of SecurityActions to return. If unspecified, at most 50 SecurityActions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
▼ ▲ apigee.organizations.environments.securityActions.create
Path : v1/{+parent}/securityActions
Description : CreateSecurityAction creates a SecurityAction.
Flat Path : v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Required : Yes
Pattern : ^organizations/[^/]+/environments/[^/]+$
Location : path
Description : Required. The organization and environment that this SecurityAction applies to. Format: organizations/{org}/environments/{env}
Type : string
securityActionId
Location : query
Type : string
Description : Required. The ID to use for the SecurityAction, which will become the final component of the action's resource name. This value should be 0-61 characters, and valid format is (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$).
Parameter Order : parent
HTTP Method : POST
▼ ▲ apigee.organizations.environments.securityActions.disable
Description : Disable a SecurityAction. The `state` of the SecurityAction after disabling is `DISABLED`. `DisableSecurityAction` can be called on SecurityActions in the state `ENABLED`; SecurityActions in a different state (including `DISABLED`) return an error.
HTTP Method : POST
Path : v1/{+name}:disable
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Type : string
Required : Yes
Description : Required. The name of the SecurityAction to disable. Format: organizations/{org}/environments/{env}/securityActions/{security_action}
Location : path
Pattern : ^organizations/[^/]+/environments/[^/]+/securityActions/[^/]+$
Flat Path : v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}:disable
Parameter Order : name
▼ ▲ apigee.organizations.environments.securityActions.get
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
HTTP Method : GET
Parameters :
name
Description : Required. The fully qualified name of the SecurityAction to retrieve. Format: organizations/{org}/environments/{env}/securityActions/{security_action}
Required : Yes
Location : path
Type : string
Pattern : ^organizations/[^/]+/environments/[^/]+/securityActions/[^/]+$
Description : Get a SecurityAction by name.
Flat Path : v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}
▼ ▲ apigee.organizations.environments.securityActions.enable
HTTP Method : POST
Description : Enable a SecurityAction. The `state` of the SecurityAction after enabling is `ENABLED`. `EnableSecurityAction` can be called on SecurityActions in the state `DISABLED`; SecurityActions in a different state (including `ENABLED) return an error.
Parameters :
name
Type : string
Location : path
Required : Yes
Pattern : ^organizations/[^/]+/environments/[^/]+/securityActions/[^/]+$
Description : Required. The name of the SecurityAction to enable. Format: organizations/{org}/environments/{env}/securityActions/{security_action}
Parameter Order : name
Path : v1/{+name}:enable
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}:enable
▼ ▲ apigee.organizations.environments.getAddonsConfig
Parameter Order : name
Description : Gets the add-ons config of an environment.
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Flat Path : v1/organizations/{organizationsId}/environments/{environmentsId}/addonsConfig
Path : v1/{+name}
Parameters :
name
Required : Yes
Pattern : ^organizations/[^/]+/environments/[^/]+/addonsConfig$
Location : path
Type : string
Description : Required. Name of the add-ons config. Must be in the format of `/organizations/{org}/environments/{env}/addonsConfig`
▼ ▲ apigee.organizations.environments.getSecurityActionsConfig
Parameter Order : name
HTTP Method : GET
Flat Path : v1/organizations/{organizationsId}/environments/{environmentsId}/securityActionsConfig
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Required : Yes
Type : string
Pattern : ^organizations/[^/]+/environments/[^/]+/securityActionsConfig$
Description : Required. The name of the SecurityActionsConfig to retrieve. This will always be: `organizations/{org}/environments/{env}/security_actions_config`
Location : path
Path : v1/{+name}
Description : GetSecurityActionConfig returns the current SecurityActions configuration.
▼ ▲ apigee.organizations.environments.updateSecurityActionsConfig
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Flat Path : v1/organizations/{organizationsId}/environments/{environmentsId}/securityActionsConfig
Path : v1/{+name}
Parameters :
updateMask
Type : string
Location : query
Description : The list of fields to update.
Format : google-fieldmask
name
Location : path
Type : string
Pattern : ^organizations/[^/]+/environments/[^/]+/securityActionsConfig$
Required : Yes
Description : This is a singleton resource, the name will always be set by SecurityActions and any user input will be ignored. The name is always: `organizations/{org}/environments/{env}/security_actions_config`
Description : UpdateSecurityActionConfig updates the current SecurityActions configuration. This method is used to enable/disable the feature at the environment level.