CreateSecurityAction creates a SecurityAction.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: apigee1 --scope <scope> organizations environments-security-actions-create ...

Required Scalar Argument

  • <parent> (string)
    • Required. The organization and environment that this SecurityAction applies to. Format: organizations/{org}/environments/{env}

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

GoogleCloudApigeeV1SecurityAction:
  condition-config:
    access-tokens: [string]
    api-keys: [string]
    api-products: [string]
    bot-reasons: [string]
    developer-apps: [string]
    developers: [string]
    ip-address-ranges: [string]
    user-agents: [string]
  create-time: string
  deny:
    response-code: integer
  description: string
  expire-time: string
  name: string
  state: string
  ttl: string
  update-time: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r .condition-config access-tokens=et
    • Optional. A list of access_tokens. Limit 1000 per action.
    • Each invocation of this argument appends the given value to the array.
  • api-keys=et
    • Optional. A list of API keys. Limit 1000 per action.
    • Each invocation of this argument appends the given value to the array.
  • api-products=dolor
    • Optional. A list of API Products. Limit 1000 per action.
    • Each invocation of this argument appends the given value to the array.
  • bot-reasons=erat
    • Optional. A list of Bot Reasons. Current options: Flooder, Brute Guessor, Static Content Scraper, OAuth Abuser, Robot Abuser, TorListRule, Advanced Anomaly Detection, Advanced API Scraper, Search Engine Crawlers, Public Clouds, Public Cloud AWS, Public Cloud Azure, and Public Cloud Google.
    • Each invocation of this argument appends the given value to the array.
  • developer-apps=dolore
    • Optional. A list of developer apps. Limit 1000 per action.
    • Each invocation of this argument appends the given value to the array.
  • developers=vero
    • Optional. A list of developers. Limit 1000 per action.
    • Each invocation of this argument appends the given value to the array.
  • ip-address-ranges=ea
    • Optional. A list of IP addresses. This could be either IPv4 or IPv6. Limited to 100 per action.
    • Each invocation of this argument appends the given value to the array.

  • user-agents=et

    • Optional. A list of user agents to deny. We look for exact matches. Limit 50 per action.
    • Each invocation of this argument appends the given value to the array.

  • .. create-time=amet.

    • Output only. The create time for this SecurityAction.

  • deny response-code=61

    • Optional. The HTTP response code if the Action = DENY.

  • .. description=sanctus

    • Optional. An optional user provided description of the SecurityAction.
  • expire-time=sed
    • The expiration for this SecurityAction.
  • name=dolor
    • Immutable. This field is ignored during creation as per AIP-133. Please set the security_action_id field in the CreateSecurityActionRequest when creating a new SecurityAction. Format: organizations/{org}/environments/{env}/securityActions/{security_action}
  • state=et
    • Required. Only an ENABLED SecurityAction is enforced. An ENABLED SecurityAction past its expiration time will not be enforced.
  • ttl=et
    • Input only. The TTL for this SecurityAction.
  • update-time=erat
    • Output only. The update time for this SecurityAction. This reflects when this SecurityAction changed states.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p security-action-id=string
    • 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?$).

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").