### Get an Instance command usage Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_instances_get.md Basic syntax for executing the get command. ```bash apigeecli instances get [flags] ``` -------------------------------- ### Import target servers example Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_targetservers_import.md Example usage of the import command specifying a file and environment. ```bash Import a file containing target servers: apigeecli targetservers import -f samples/targetservers.json -e $env ``` -------------------------------- ### Create API Hub API Example Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_apihub_apis_create.md Example usage of the create command with required flags. ```bash Create a new API: apigeecli apihub apis create -i $apiId -f ./test/api.json -r $region -o $project --default-token ``` -------------------------------- ### Get command help options Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_environments_traceconfig_get.md Displays help information for the get command. ```bash -h, --help help for get ``` -------------------------------- ### apigeecli keystores get Synopsis Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_keystores_get.md This is the basic command synopsis for getting a Key Store. ```bash apigeecli keystores get [flags] ``` -------------------------------- ### Import App Developers example Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_developers_import.md Example command to import developers from a specific file path. ```bash apigeecli developers import -f samples/developers.json ``` -------------------------------- ### Import API categories example Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_apicategories_import.md Example usage of the import command with a file and site ID. ```bash apigeecli apicategories import --file samples/apicategories.json --siteid $siteId --default-token ``` -------------------------------- ### Import API documentation example Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_apidocs_import.md Example usage for importing data into a new organization, specifying the folder and site ID. ```bash apigeecli apidocs import -f samples/apidocs -s $siteId ``` -------------------------------- ### Create API proxy from GitHub example Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_apis_create_github.md Example command demonstrating the required flags for specifying the proxy name, space, owner, repository, and path. ```bash Creates an API proxy from a GitHub repo apigeecli apis create github --name=petstore --space=space1 \ --owner=apigee \ --repo=api-platform-samples \ --proxy-path=sample-proxies/apikey --default-token ``` -------------------------------- ### Install apigeecli on Linux or Darwin Source: https://github.com/apigee/apigeecli/blob/main/README.md Downloads and installs the latest version of the apigeecli binary. ```sh curl -L https://raw.githubusercontent.com/apigee/apigeecli/main/downloadLatest.sh | sh - ``` -------------------------------- ### Create GraphQL API Proxy Example Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_apis_create_graphql.md Example command to create an API proxy named petstore with CORS enabled and default token authentication. ```bash Create an API Proxy from a GraphQL schema: apigeecli apis create graphql -n petstore --space=space1 --action=parse_verify --add-cors=true --default-token ``` -------------------------------- ### Test IAM policy examples Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_spaces_iam_test.md Examples demonstrating how to test IAM permissions for different resources and verbs. ```bash Test IAM for a space: apigeecli spaces iam test --space=space1 --res=proxies apigeecli spaces iam test --space=space1 --verb=create --res=sharedflows ``` -------------------------------- ### Install apigeecli Binary or Docker Image Source: https://context7.com/apigee/apigeecli/llms.txt Installs the apigeecli binary on Linux/Darwin systems using a curl script, or pulls the latest Docker image for containerized environments. ```bash # Install apigeecli binary (Linux/Darwin) curl -L https://raw.githubusercontent.com/apigee/apigeecli/main/downloadLatest.sh | sh - ``` ```bash # Or use Docker docker pull ghcr.io/apigee/apigeecli:latest ``` -------------------------------- ### Set Space Viewer role example Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_spaces_iam_setviewer.md Example command to assign the viewer role to a user in a specific space. ```bash Set Space Viewer role for user in a space: apigeecli spaces iam setviewer --space=space1 --member-type=user --name=developer@any.com ``` -------------------------------- ### apigeecli Preferences Get Help Flags Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_preferences_get.md Displays help information for the 'get' command within apigeecli preferences. This is useful for understanding available options. ```bash apigeecli preferences get -h ``` -------------------------------- ### apigeecli keystores get Options Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_keystores_get.md These are the specific flags available for the 'get' command, including the required name flag. ```bash -h, --help help for get -n, --name string Name of the key store ``` -------------------------------- ### apigeecli apidocs get Options Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_apidocs_get.md These are the specific options for the 'get' command, including help, catalog ID, and catalog title. ```bash -h, --help help for get -i, --id string Catalog ID --title string Catalog Title ``` -------------------------------- ### Get apigeecli Preferences Command Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_preferences_get.md Use this command to retrieve the current preferences for the apigeecli. No specific setup is required beyond having the tool installed. ```bash apigeecli preferences get [flags] ``` -------------------------------- ### List Shared Flows Command Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_sharedflows_list.md Use this command to list all shared flows in your Apigee organization. No setup is required beyond having the apigeecli installed. ```bash apigeecli sharedflows list [flags] ``` -------------------------------- ### Command Options Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_apihub_instances_get.md Available flags for the get command. ```bash -h, --help help for get -i, --id string API Hub Intance Id ``` -------------------------------- ### Delete Apigee API Hub Dependency Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_apihub_dependencies_delete.md Use this command to delete a specific dependency in Apigee API Hub. Ensure you have the correct Dependency ID. This command does not require any special setup beyond having the apigeecli installed and authenticated. ```bash apigeecli apihub dependencies delete --id="your-dependency-id" ``` -------------------------------- ### Get a Key Store Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_keystores_get.md Use this command to retrieve details of a specific Key Store. Specify the name of the Key Store using the -n flag. Other flags like -o for organization and -e for environment may be required depending on your setup. ```bash apigeecli keystores get --name ``` -------------------------------- ### Create API Product with Basic Configuration Source: https://github.com/apigee/apigeecli/blob/main/samples/README.md Create a new API product with specified name, display name, operation group, and environment. ```bash apigeecli products create --name $product_name --display-name $product_name --opgrp $ops_file --envs $env --space $space --approval auto --attrs access=public --default-token ``` -------------------------------- ### Get shared flow command options Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_sharedflows_get.md Specific flags available for the get command. ```bash -h, --help help for get -n, --name string Shared flow name -v, --rev int shared flow revision (default -1) ``` -------------------------------- ### Get shared flow command usage Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_sharedflows_get.md Basic syntax for executing the get command. ```bash apigeecli sharedflows get [flags] ``` -------------------------------- ### Keystore create options Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_keystores_create.md Available flags for specifying the name of the key store. ```bash -h, --help help for create -n, --name string Name of the key store ``` -------------------------------- ### Security profile get options Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_securityprofiles_get.md Flags specific to the get command for identifying the profile. ```bash -h, --help help for get -n, --name string Name of the security profile -v, --revision string Revision of the security profile ``` -------------------------------- ### Create a Key Store command Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_keystores_create.md Basic syntax for executing the keystores create command. ```bash apigeecli keystores create [flags] ``` -------------------------------- ### Import Environment References from File Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_references_import.md Example command to import references from a specified JSON file into a target environment. ```bash Import Environment References from a file: apigeecli references import -f samples/references.json -e $env ``` -------------------------------- ### GET apigeecli flowhooks get Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_flowhooks_get.md Retrieves the details of a specific flowhook in an Apigee environment. ```APIDOC ## GET apigeecli flowhooks get ### Description Retrieves the configuration of a specific flowhook point. ### Method GET ### Endpoint apigeecli flowhooks get ### Parameters #### Flags - **--name** (string) - Required - Flowhook point - **--env** (string) - Required - Apigee environment name - **--org** (string) - Required - Apigee organization name ### Request Example apigeecli flowhooks get --org my-org --env prod --name PreProxyFlowHook ``` -------------------------------- ### apigeecli datacollectors get Synopsis Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_datacollectors_get.md This is the synopsis for the get command, outlining its basic structure. ```bash apigeecli datacollectors get [flags] ``` -------------------------------- ### Instance get command options Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_instances_get.md Required and optional flags for specifying the instance and organization. ```bash -h, --help help for get -n, --name string Name of the instance -o, --org string Apigee organization name ``` -------------------------------- ### GET apigeecli sync get Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_sync_get.md Retrieves the list of identities with access to control plane resources. ```APIDOC ## GET apigeecli sync get ### Description Show the list of identities with access to control plane resources. ### Method GET ### Endpoint apigeecli sync get ### Parameters #### Options - **-a, --account** (string) - Optional - Path Service Account private key in JSON - **--api** (api) - Optional - Sets the control plane API. Must be one of prod, autopush or staging; default is prod - **--default-token** (flag) - Optional - Use Google default application credentials access token - **--disable-check** (flag) - Optional - Disable check for newer versions - **--metadata-token** (flag) - Optional - Metadata OAuth2 access token - **--no-output** (flag) - Optional - Disable printing all statements to stdout - **--no-warnings** (flag) - Optional - Disable printing warnings to stderr - **-o, --org** (string) - Optional - Apigee organization name - **--print-output** (boolean) - Optional - Control printing of info log statements (default true) - **-r, --region** (string) - Optional - Apigee control plane region name; default is https://apigee.googleapis.com - **-t, --token** (string) - Optional - Google OAuth Token ``` -------------------------------- ### GET apigeecli kvms entries get Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_kvms_entries_get.md Retrieves a specific entry from a Key Value Map. ```APIDOC ## GET apigeecli kvms entries get ### Description Retrieves a specific entry from a Key Value Map (KVM) within an Apigee organization. ### Method GET ### Endpoint apigeecli kvms entries get ### Parameters #### Flags - **--env** (string) - Required - Environment name - **--key** (string) - Required - KV Map entry name - **--map** (string) - Required - KV Map Name - **--proxy** (string) - Optional - API Proxy name ### Options inherited from parent commands - **--account** (string) - Optional - Path Service Account private key in JSON - **--api** (string) - Optional - Sets the control plane API (prod, autopush, staging) - **--org** (string) - Required - Apigee organization name - **--token** (string) - Optional - Google OAuth Token ``` -------------------------------- ### Create and Import API Proxy Bundles Source: https://context7.com/apigee/apigeecli/llms.txt Imports API proxy configurations from zip archives or directories. ```bash # Create proxy from zip bundle apigeecli apis create bundle -n my-proxy \ -f ./my-proxy.zip \ -o my-org \ --default-token # Import multiple proxies from folder apigeecli apis import -f samples/apis --default-token ``` -------------------------------- ### apigeecli appgroups apps keys get Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_appgroups_apps_keys_get.md Gets details for a consumer key for an AppGroup app. ```APIDOC ## GET /apigee/apigeecli/appgroups/apps/keys ### Description Gets details for a consumer key for an AppGroup app. ### Method GET ### Endpoint /apigee/apigeecli/appgroups/apps/keys ### Parameters #### Query Parameters - **app-name** (string) - Required - Name of the app - **key** (string) - Required - App consumer key - **name** (string) - Required - Name of the AppGroup - **account** (string) - Optional - Path Service Account private key in JSON - **api** (string) - Optional - Sets the control plane API. Must be one of prod, autopush or staging; default is prod - **default-token** (boolean) - Optional - Use Google default application credentials access token - **disable-check** (boolean) - Optional - Disable check for newer versions - **metadata-token** (boolean) - Optional - Metadata OAuth2 access token - **no-output** (boolean) - Optional - Disable printing all statements to stdout - **no-warnings** (boolean) - Optional - Disable printing warnings to stderr - **org** (string) - Optional - Apigee organization name - **print-output** (boolean) - Optional - Control printing of info log statements (default true) - **region** (string) - Optional - Apigee control plane region name; default is https://apigee.googleapis.com - **token** (string) - Optional - Google OAuth Token ### Request Example ```json { "app-name": "your-app-name", "key": "your-consumer-key", "name": "your-appgroup-name" } ``` ### Response #### Success Response (200) - **details** (object) - Details of the consumer key - **consumerKey** (string) - The consumer key. - **consumerSecret** (string) - The consumer secret. - **issuedAt** (string) - The timestamp when the key was issued. - **keyLabel** (string) - The label for the key. - **status** (string) - The status of the key. #### Response Example ```json { "details": { "consumerKey": "example-key", "consumerSecret": "example-secret", "issuedAt": "2026-01-05T10:00:00Z", "keyLabel": "default", "status": "approved" } } ``` ``` -------------------------------- ### Set up apigeecli Preferences Source: https://github.com/apigee/apigeecli/blob/main/samples/README.md Configure apigeecli with your organization preferences. ```bash apigeecli prefs set -o $org ``` -------------------------------- ### Command options Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_appgroups_apps_keys_delete-product.md Required and optional flags for specifying the AppGroup, app, key, and product. ```bash --app-name string Name of the app -h, --help help for delete-product -k, --key string App consumer key -n, --name string Name of the AppGroup -p, --prod-name string API Product Name ``` -------------------------------- ### GET apigeecli apis get Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_apis_get.md Retrieves an API Proxy by name, including a list of its revisions. ```APIDOC ## GET apigeecli apis get ### Description Gets an API Proxy by name, including a list of its revisions. ### Method GET ### Endpoint apigeecli apis get ### Parameters #### Flags - **--name** (string) - Required - API Proxy name - **--rev** (int) - Optional - API Proxy revision (default -1) ### Options inherited from parent commands - **--account** (string) - Optional - Path Service Account private key in JSON - **--api** (string) - Optional - Sets the control plane API (prod, autopush, or staging; default is prod) - **--default-token** (boolean) - Optional - Use Google default application credentials access token - **--disable-check** (boolean) - Optional - Disable check for newer versions - **--metadata-token** (boolean) - Optional - Metadata OAuth2 access token - **--no-output** (boolean) - Optional - Disable printing all statements to stdout - **--no-warnings** (boolean) - Optional - Disable printing warnings to stderr - **--org** (string) - Optional - Apigee organization name - **--print-output** (boolean) - Optional - Control printing of info log statements (default true) - **--region** (string) - Optional - Apigee control plane region name (default is https://apigee.googleapis.com) - **--token** (string) - Optional - Google OAuth Token ``` -------------------------------- ### Command options for datastores create Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_datastores_create.md Available flags for configuring the data store target type and associated storage parameters. ```bash -b, --bucket-name string Name of the Cloud Storage bucket. Required for gcs targetType -d, --dataset string BigQuery dataset name Required for bigquery targetType -g, --gcs-path string Path of Cloud Storage bucket Required for gcs targetType -h, --help help for create -n, --name string Display name for the data store -f, --prefix string Prefix of BigQuery table Required for bigquery targetType -p, --project-id string GCP project in which the datastore exists --target string Destination storage type. Supported types gcs or bigquery ``` -------------------------------- ### List command options Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_observations_sources_list.md Configuration flags for pagination when listing observation sources. ```bash -h, --help help for list --page-size int The maximum number of versions to return (default -1) --page-token string A page token, received from a previous call ``` -------------------------------- ### apigeecli targetservers get Synopsis Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_targetservers_get.md This is the synopsis for the apigeecli targetservers get command, outlining its basic structure. ```bash apigeecli targetservers get [flags] ``` -------------------------------- ### Datastore get command options Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_datastores_get.md Available flags for specifying the datastore to retrieve. ```bash -h, --help help for get -i, --id string Datastore UUID -n, --name string Datastore display name ``` -------------------------------- ### Observation Source Get Options Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_observations_sources_get.md Flags available for the get command to specify the observation source ID. ```bash -h, --help help for get -i, --id string Observation Source Id ``` -------------------------------- ### GET /apigee/apigeecli environments traceconfig get Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_environments_traceconfig_get.md Retrieves the Distributed Trace configuration for a specified Apigee environment. ```APIDOC ## GET /apigee/apigeecli environments traceconfig get ### Description Get Distributed Trace config for the environment. ### Method GET ### Endpoint /apigee/apigeecli environments traceconfig get ### Parameters #### Query Parameters - **-a, --account** (string) - Optional - Path Service Account private key in JSON - **--api** (string) - Optional - Sets the control plane API. Must be one of prod, autopush or staging; default is prod - **--default-token** (boolean) - Optional - Use Google default application credentials access token - **--disable-check** (boolean) - Optional - Disable check for newer versions - **-e, --env** (string) - Optional - Apigee environment name - **--metadata-token** (boolean) - Optional - Metadata OAuth2 access token - **--no-output** (boolean) - Optional - Disable printing all statements to stdout - **--no-warnings** (boolean) - Optional - Disable printing warnings to stderr - **-o, --org** (string) - Optional - Apigee organization name - **--print-output** (boolean) - Optional - Control printing of info log statements (default true) - **-r, --region** (string) - Optional - Apigee control plane region name; default is https://apigee.googleapis.com - **-t, --token** (string) - Optional - Google OAuth Token ### Request Example ```json { "example": "apigeecli environments traceconfig get -o YOUR_ORG -e YOUR_ENV" } ``` ### Response #### Success Response (200) - **traceConfig** (object) - The Distributed Trace configuration for the environment. #### Response Example ```json { "example": "{\"enabled\": true, \"samplerConfig\": { \"sampler\": \"PROBABILITY\", \"percentage\": 10 }}" } ``` ``` -------------------------------- ### Manage Keystores Source: https://context7.com/apigee/apigeecli/llms.txt Commands for creating keystores to manage TLS certificates. ```bash apigeecli keystores create -n my-keystore \ -e dev \ --default-token ``` -------------------------------- ### Import Key-Value Maps (KVMs) using apigeecli Source: https://github.com/apigee/apigeecli/blob/main/samples/README.md Import KVMs from a specified directory. ```bash apigeecli kvms import -f samples/kvms ``` -------------------------------- ### GET /apigee/apigeecli environments secincidents get Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_environments_secincidents_get.md Retrieves a specific security incident by its name from an Apigee environment. ```APIDOC ## GET /apigee/apigeecli environments secincidents get ### Description Returns a security incidents by name. ### Method GET ### Endpoint /apigee/apigeecli environments secincidents get ### Parameters #### Query Parameters - **name** (string) - Required - Name of the security incident - **env** (string) - Optional - Apigee environment name - **org** (string) - Optional - Apigee organization name - **region** (string) - Optional - Apigee control plane region name; default is https://apigee.googleapis.com - **account** (string) - Optional - Path Service Account private key in JSON - **api** (string) - Optional - Sets the control plane API. Must be one of prod, autopush or staging; default is prod - **token** (string) - Optional - Google OAuth Token ### Request Example ```json { "example": "apigeecli environments secincidents get -n incident-name -e my-env -o my-org" } ``` ### Response #### Success Response (200) - **Details** (object) - Information about the security incident. #### Response Example ```json { "example": "{\"name\": \"projects/my-project/environments/my-env/securityIncidents/incident-id\", \"displayName\": \"Example Incident\", \"state\': \"ACTIVE\", \"createTime\": \"2023-01-01T10:00:00Z\"}" } ``` ``` -------------------------------- ### GET apigeecli apihub deployments get Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_apihub_deployments_get.md Retrieves detailed information about a specific deployment in the API Hub. ```APIDOC ## GET apigeecli apihub deployments get ### Description Retrieves the details for a specific deployment using its unique identifier. ### Method GET ### Endpoint apigeecli apihub deployments get ### Parameters #### Flags - **-i, --id** (string) - Required - Deployment ID ### Options inherited from parent commands - **-a, --account** (string) - Optional - Path Service Account private key in JSON - **--api** (api) - Optional - Sets the control plane API (prod, autopush, or staging; default is prod) - **--default-token** (boolean) - Optional - Use Google default application credentials access token - **--disable-check** (boolean) - Optional - Disable check for newer versions - **--metadata-token** (boolean) - Optional - Metadata OAuth2 access token - **--no-output** (boolean) - Optional - Disable printing all statements to stdout - **--no-warnings** (boolean) - Optional - Disable printing warnings to stderr - **-o, --org** (string) - Optional - Apigee organization name - **--print-output** (boolean) - Optional - Control printing of info log statements (default true) - **-r, --region** (string) - Optional - API Hub region name - **-t, --token** (string) - Optional - Google OAuth Token ``` -------------------------------- ### Import API Products (Legacy) using apigeecli Source: https://github.com/apigee/apigeecli/blob/main/samples/README.md Import legacy API products from a JSON file. ```bash apigeecli products import -f samples/apiproduct-legacy.json --default-token ``` -------------------------------- ### Remove Space Editor role example Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_spaces_iam_removerole.md Example command to remove the spaceContentEditor role for a specific user. ```bash Remove Space Editor role for user in a space: apigeecli spaces iam removerole --space=space1 --name=user:developer@any.com --role=roles/apigee.spaceContentEditor ``` -------------------------------- ### List Key Stores command syntax Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_keystores_list.md Basic command structure for listing key stores. ```bash apigeecli keystores list [flags] ``` -------------------------------- ### View help for enable command Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_environments_secactionscfg_enable.md Displays help information for the enable command. ```bash -h, --help help for enable ``` -------------------------------- ### Import Keystores Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_keystores_import.md Use this command to import keystores from a JSON file into a specified Apigee environment. Ensure the file path and environment name are correctly provided. ```bash apigeecli keystores import -f samples/keystores.json -e $env ``` -------------------------------- ### GET /apigee/apigeecli environments traceconfig overrides get Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_environments_traceconfig_overrides_get.md Retrieves distributed trace configuration overrides for an Apigee environment. ```APIDOC ## GET /apigee/apigeecli environments traceconfig overrides get ### Description Retrieves distributed trace configuration overrides for an Apigee environment. ### Method GET ### Endpoint /apigee/apigeecli environments traceconfig overrides get ### Parameters #### Query Parameters - **-n, --name** (string) - Required - Trace configuration override name - **-a, --account** (string) - Optional - Path Service Account private key in JSON - **--api** (string) - Optional - Sets the control plane API. Must be one of prod, autopush or staging; default is prod - **--default-token** (boolean) - Optional - Use Google default application credentials access token - **--disable-check** (boolean) - Optional - Disable check for newer versions - **-e, --env** (string) - Optional - Apigee environment name - **--metadata-token** (boolean) - Optional - Metadata OAuth2 access token - **--no-output** (boolean) - Optional - Disable printing all statements to stdout - **--no-warnings** (boolean) - Optional - Disable printing warnings to stderr - **-o, --org** (string) - Optional - Apigee organization name - **--print-output** (boolean) - Optional - Control printing of info log statements (default true) - **-r, --region** (string) - Optional - Apigee control plane region name; default is https://apigee.googleapis.com - **-t, --token** (string) - Optional - Google OAuth Token ### Request Example ```bash apigeecli environments traceconfig overrides get -n "override-name" -o "my-org" -e "my-env" ``` ### Response #### Success Response (200) - **Output**: (string) - The retrieved trace configuration override details. #### Response Example ```json { "override": { "name": "override-name", "enabled": true, "traceConfig": { "samplingConfig": { "samplingRate": 100 } } } } ``` ``` -------------------------------- ### apigeecli Developers Subscriptions Create Synopsis Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_developers_subscriptions_create.md This is the synopsis for the create command, showing the basic structure and available flags. ```bash apigeecli developers subscriptions create [flags] ``` -------------------------------- ### apigeecli datacollectors get Options Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_datacollectors_get.md These are the specific options available for the get command, including the data collector name. ```bash -h, --help help for get -n, --name string Data Collector Name ``` -------------------------------- ### Create a new data store command Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_datastores_create.md Basic syntax for executing the datastores create command. ```bash apigeecli datastores create [flags] ``` -------------------------------- ### Create API Products Source: https://context7.com/apigee/apigeecli/llms.txt Configures API products with operation groups, quotas, and custom attributes. ```bash # Create product with operation group and auto approval apigeecli products create --name my-product \ --display-name "My Product" \ --opgrp ./ops-group.json \ --envs dev,prod \ --space space1 \ --approval auto \ --attrs access=public \ --default-token # Create product with quota limits apigeecli products create --name premium-product \ --display-name "Premium Product" \ --opgrp ./ops-group.json \ --envs prod \ --approval auto \ --space space1 \ --attrs access=public \ --quota 100 \ --interval 1 \ --unit minute \ --default-token # Create product with LLM quota for AI APIs apigeecli products create --name llm-product \ --display-name "LLM Product" \ --llmopgrp ./llm-ops.json \ --llm-quota=1000 \ --llm-quota-interval=1 \ --llm-quota-timeunit=minute \ --envs dev \ --space space1 \ --approval auto \ --attrs access=public \ --default-token ``` -------------------------------- ### GET apigeecli apihub apis versions get Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_apihub_apis_versions_get.md Retrieves details for a specific API version from the Apigee API Hub. ```APIDOC ## GET apigeecli apihub apis versions get ### Description Retrieves details for a specific API version. Optionally, the API version definition can be retrieved using the definition flag. ### Method GET ### Endpoint apigeecli apihub apis versions get ### Parameters #### Flags - **--api-id** (string) - Required - API ID - **-i, --id** (string) - Required - API Version ID - **-d, --definition** (string) - Optional - Get API Version definition #### Inherited Options - **-a, --account** (string) - Optional - Path Service Account private key in JSON - **--api** (string) - Optional - Sets the control plane API (prod, autopush, or staging) - **-o, --org** (string) - Optional - Apigee organization name - **-r, --region** (string) - Optional - API Hub region name - **-t, --token** (string) - Optional - Google OAuth Token ``` -------------------------------- ### CLI Command: apigeecli keystores import Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_keystores_import.md Imports a file containing keystore definitions into a specified Apigee environment. ```APIDOC ## apigeecli keystores import ### Description Imports a file containing keystores into an Apigee environment. ### Method CLI Command ### Endpoint apigeecli keystores import [flags] ### Parameters #### Flags - **-f, --file** (string) - Required - File containing keystores - **-c, --conn** (int) - Optional - Number of connections (default 4) - **-e, --env** (string) - Required - Apigee environment name - **-o, --org** (string) - Required - Apigee organization name ### Request Example apigeecli keystores import -f samples/keystores.json -e $env -o $org ``` -------------------------------- ### List command help options Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_datacollectors_list.md Displays help information for the list command. ```bash -h, --help help for list ``` -------------------------------- ### List deployments command syntax Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_apihub_deployments_list.md Basic command structure for listing deployments. ```bash apigeecli apihub deployments list [flags] ``` -------------------------------- ### apigeecli apihub apis versions specs get Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_apihub_apis_versions_specs_get.md Retrieves a spec for a given API Version in APIhub. You can specify the API ID, Version ID, and Spec ID to get a particular spec. Options are available to get the spec contents directly or save them to a file. ```APIDOC ## GET /apigee/apigeecli/apihub/apis/versions/specs ### Description Get a spec for an API Version in APIhub. ### Method GET ### Endpoint /apigee/apigeecli/apihub/apis/versions/specs ### Parameters #### Query Parameters - **api-id** (string) - Required - API ID - **version** (string) - Required - API Version ID - **spec-id** (string) - Required - Spec ID - **contents** (boolean) - Optional - Get contents of the spec - **output** (string) - Optional - Path to a file to write the contents of the spec ### Request Example ```json { "api-id": "your-api-id", "version": "your-api-version", "spec-id": "your-spec-id", "contents": true, "output": "/path/to/save/spec.json" } ``` ### Response #### Success Response (200) - **spec_content** (string) - The content of the API spec if 'contents' is true. - **message** (string) - Confirmation message if saving to a file. #### Response Example ```json { "spec_content": "{\"openapi\": \"3.0.0\", \"info\": {\"title\": \"My API\", \"version\": \"1.0.0\"}}" } ``` ``` -------------------------------- ### apigeecli targetservers get Options Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_targetservers_get.md These are the specific options available for the apigeecli targetservers get command, including the required name flag. ```bash -h, --help help for get -n, --name string Name of the targetserver ``` -------------------------------- ### Import API Products from JSON File Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_products_import.md Use this command to import API products defined in a JSON file. Specify the file path using the -f flag. The --default-token flag is used for authentication. ```bash apigeecli products import -f samples/apiproduct-legacy.json --default-token ``` ```bash apigeecli products import -f samples/apiproduct-gqlgroup.json --default-token ``` -------------------------------- ### Create API proxy from GitHub command usage Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_apis_create_github.md Basic syntax for executing the command to create an API proxy from a GitHub repository. ```bash apigeecli apis create github [flags] ``` -------------------------------- ### apigeecli environments secactions get Options Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_environments_secactions_get.md Flags specific to the 'get' command, such as '-n' or '--name' to specify the Security Action name. ```bash -h, --help help for get -n, --name string Security Action name ``` -------------------------------- ### apigeecli apidocs get Synopsis Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_apidocs_get.md This is the basic command structure for getting a catalog item. Flags can be added to specify the item and target organization/site. ```bash apigeecli apidocs get [flags] ``` -------------------------------- ### Import API Proxy Bundles Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_apis_import.md Use this command to import a folder containing API proxy bundles. Ensure the folder path and any necessary authentication flags are correctly specified. ```bash apigeecli apis import -f samples/apis --default-token ``` -------------------------------- ### List dependencies command usage Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_apihub_dependencies_list.md Basic syntax for executing the list dependencies command. ```bash apigeecli apihub dependencies list [flags] ``` -------------------------------- ### Command Options Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_apps_genkey.md Available flags for configuring the developer KeyPair generation. ```bash -c, --callback string The callbackUrl is used by OAuth -d, --devid string The developer's id or email -x, --expires string A setting, in seconds, for the lifetime of the consumer key -h, --help help for genkey -n, --name string Name of the developer app -p, --prods stringArray A list of api products -s, --scopes stringArray OAuth scopes ``` -------------------------------- ### Deploy API Proxy with Options Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_apis_deploy.md Configure deployment options such as environment, API proxy name, revision, and whether to force deployment or wait for completion. The 'safedeploy' option defaults to true, ensuring a conflict check before deployment. ```bash apigeecli apis deploy -e -n -v --ovr --wait --safedeploy=false ``` -------------------------------- ### apigeecli environments secactions get Synopsis Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_environments_secactions_get.md This is the basic command structure for getting a SecurityAction. Flags like --name are essential for specifying the target SecurityAction. ```bash apigeecli environments secactions get [flags] ``` -------------------------------- ### apigeecli apis get Flags Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_apis_get.md These are the specific flags available for the apigeecli apis get command, including options for help, API proxy name, and revision. ```bash -h, --help help for get -n, --name string API Proxy name -v, --rev int API Proxy revision (default -1) ``` -------------------------------- ### POST /products/rateplans/create Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_products_rateplans_create.md Creates a new rate plan for a specified API product using a JSON configuration file. ```APIDOC ## POST /products/rateplans/create ### Description Creates a rate plan for an API product using a provided JSON file. ### Method POST ### Endpoint apigeecli products rateplans create ### Parameters #### Flags - **--product** (string) - Required - Name of the API Product - **--rateplan** (string) - Required - File containing Rate plan JSON ### Options inherited from parent commands - **--account** (string) - Optional - Path Service Account private key in JSON - **--api** (string) - Optional - Sets the control plane API (prod, autopush, or staging) - **--org** (string) - Optional - Apigee organization name - **--region** (string) - Optional - Apigee control plane region name - **--token** (string) - Optional - Google OAuth Token ``` -------------------------------- ### apigeecli Deployment Get Flags Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_apihub_deployments_get.md These flags are specific to the 'get' command for API Hub deployments. The '-i' or '--id' flag is mandatory to identify the deployment. ```bash -h, --help help for get -i, --id string Deployment ID ``` -------------------------------- ### List dependencies command options Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_apihub_dependencies_list.md Available flags for filtering and pagination when listing dependencies. ```bash -f, --filter string filter expression -h, --help help for list --page-size int The maximum number of versions to return (default -1) --page-token string A page token, received from a previous call ``` -------------------------------- ### apigeecli keystores get Inherited Options Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_keystores_get.md These flags are inherited from parent commands and can be used with 'get' to specify account, API environment, token types, and output controls. ```bash -a, --account string Path Service Account private key in JSON --api api Sets the control plane API. Must be one of prod, autopush or staging; default is prod --default-token Use Google default application credentials access token --disable-check Disable check for newer versions -e, --env string Apigee environment name --metadata-token Metadata OAuth2 access token --no-output Disable printing all statements to stdout --no-warnings Disable printing warnings to stderr -o, --org string Apigee organization name --print-output Control printing of info log statements (default true) -r, --region string Apigee control plane region name; default is https://apigee.googleapis.com -t, --token string Google OAuth Token ``` -------------------------------- ### apigeecli references create Options Source: https://github.com/apigee/apigeecli/blob/main/docs/apigeecli_references_create.md Options for creating a reference, including description, name, resource type, and the resource it refers to. ```bash -d, --desc string Description for the reference -h, --help help for create -n, --name string Reference name --refers string The id of the resource to which this reference refers -s, --restype string Resource type must be KeyStore or TrustStore ```