Method: organizations.environments.getDeployedConfig

Gets the deployed configuration for an environment.

HTTP request

GET https://apigee.googleapis.com/v1/{name=organizations/*/environments/*/deployedConfig}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Name of the environment deployed configuration resource in the following format: organizations/{org}/environments/{env}/deployedConfig

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{
  "name": string,
  "sequenceNumber": string,
  "createTime": string,
  "provider": string,
  "resources": [
    {
      object (ResourceConfig)
    }
  ],
  "targets": [
    {
      object (TargetServerConfig)
    }
  ],
  "deployments": [
    {
      object (DeploymentConfig)
    }
  ],
  "flowhooks": [
    {
      object (FlowHookConfig)
    }
  ],
  "debugMask": {
    object (DebugMask)
  },
  "keystores": [
    {
      object (KeystoreConfig)
    }
  ],
  "featureFlags": {
    string: string,
    ...
  },
  "pubsubTopic": string,
  "resourceReferences": [
    {
      object (ReferenceConfig)
    }
  ]
}
Fields
name

string

The name of the environment config. Must be of the form 'organizations/{org}/environments/{env}/configs/{config_id}

sequenceNumber

string (int64 format)

A sequence number that defines an ordering on environment configs. No two configs under an environment will ever have the same sequence number. A higher sequence number means that the config was deployed more recently than one with a lower sequence number.

createTime

string (Timestamp format)

The time at which this environment config was created.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

provider

string

This field can be used by the control plane to add some context information about itself. This information could help detect the source of the document during diagnostics and debugging.

resources[]

object (ResourceConfig)

A list of resource versions in the environment.

targets[]

object (TargetServerConfig)

A list of target servers in the environment. Disabled target servers are not included.

deployments[]

object (DeploymentConfig)

A list of deployments in the environment

flowhooks[]

object (FlowHookConfig)

A list of flow hooks in the environment.

debugMask

object (DebugMask)

Debug mask that applies to all deployments in the environment.

keystores[]

object (KeystoreConfig)

A list of keystores in the environment.

featureFlags

map (key: string, value: string)

Feature flags inherited from the org and environment parents.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

pubsubTopic

string

Name of the pubsub topic for this environment.

resourceReferences[]

object (ReferenceConfig)

A list of resource references in the environment.

Authorization Scopes

Requires the following OAuth scope:

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

ResourceConfig

JSON representation
{
  "name": string,
  "location": string
}
Fields
name

string

The resource name. Only environment-scoped resource files are supported. Must be of the form 'organizations/{org}/environments/{env}/resourcefiles/{type}/{file}/revisions/{rev}'.

location

string

The location of the resource as a URI.

TargetServerConfig

JSON representation
{
  "name": string,
  "host": string,
  "port": number,
  "tlsInfo": {
    object (TlsInfoConfig)
  }
}
Fields
name

string

The target server revision name. Must be of the form 'organizations/{org}/environments/{env}/targetservers/{ts_id}/revisions/{rev}'.

host

string

Target host name.

port

number

Target port.

tlsInfo

object (TlsInfoConfig)

TLS settings for the target.

TlsInfoConfig

JSON representation
{
  "enabled": boolean,
  "clientAuthEnabled": boolean,
  "trustStore": string,
  "ciphers": [
    string
  ],
  "protocols": [
    string
  ],
  "commonName": {
    object (CommonNameConfig)
  },
  "ignoreValidationErrors": boolean,

  // Union field key_alias_or_reference can be only one of the following:
  "keyAlias": string,
  "keyAliasReference": {
    object (KeyAliasReference)
  }
  // End of list of possible types for union field key_alias_or_reference.
}
Fields
enabled

boolean

Enables one-way TLS.

clientAuthEnabled

boolean

Indicates if client auth is enabled for the target. Enables two-way TLS.

trustStore

string

The name of the Keystore or keystore reference containing trusted certificates for the server. It must be of either the form organizations/{org}/environments/{env}/keystores/{keystore} or organizations/{org}/environments/{env}/references/{reference}.

ciphers[]

string

Whitelist of supported ciphers.

protocols[]

string

Whitelist of supported TLS protocols.

commonName

object (CommonNameConfig)

Common name to validate the target against.

ignoreValidationErrors

boolean

If true, ignore TLS certificate validation errors.

Union field key_alias_or_reference.

key_alias_or_reference can be only one of the following:

keyAlias

string

The name of the Alias used for client side auth. It must be of the form: organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}

keyAliasReference

object (KeyAliasReference)

A pair of reference name and alias to use for client side auth.

KeyAliasReference

JSON representation
{
  "reference": string,
  "aliasId": string
}
Fields
reference

string

The reference name. Must be of the form: organizations/{org}/environments/{env}/references/{ref}.

aliasId

string

The alias id. Must exist in the keystore referred to by reference.

CommonNameConfig

JSON representation
{
  "name": string,
  "matchWildCards": boolean
}
Fields
name

string

matchWildCards

boolean

DeploymentConfig

JSON representation
{
  "name": string,
  "location": string,
  "basePath": string,
  "attributes": {
    string: string,
    ...
  }
}
Fields
name

string

The name of the API or shared flow revision to be deployed. Must be of the form 'organizations/{org}/apis/{api}/revisions/{rev}' or 'organizations/{org}/sharedflows/{sf}/revisions/{rev}'.

location

string

The location of the proxy bundle, as a uri.

basePath

string

Base path where the application needs to be hosted. Default value is assumed to be "/".

attributes

map (key: string, value: string)

Additional key-value metadata about the deployment.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

FlowHookConfig

JSON representation
{
  "name": string,
  "sharedFlowName": string,
  "continueOnError": boolean
}
Fields
name

string

The name of the flow hook. Must be of the form 'organizations/{org}/environments/{env}/flowhooks/{point}''. Known points are PreProxyFlowHook, PostProxyFlowHook, PreTargetFlowHook, and PostTargetFlowHook

sharedFlowName

string

The name of the shared flow to invoke. Must be of the form 'organizations/{org}/sharedflows/{sharedflow}'.

continueOnError

boolean

Should the flow abort after an error in the flow hook. Should default to true if unset.

KeystoreConfig

JSON representation
{
  "name": string,
  "aliases": [
    {
      object (AliasRevisionConfig)
    }
  ]
}
Fields
name

string

The resource name. Must be of the form: 'organizations/{org}/environments/{env}/keystores/{keystore}'.

aliases[]

object (AliasRevisionConfig)

Aliases in the keystore.

AliasRevisionConfig

JSON representation
{
  "name": string,
  "type": enum (AliasType),
  "location": string
}
Fields
name

string

The name of the alias revision included in the keystore. Must be of the form: 'organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}/revisions/{rev}'.

type

enum (AliasType)

location

string

The location of the alias file, e.g. a GCS URI.

ReferenceConfig

JSON representation
{
  "name": string,
  "resourceName": string
}
Fields
name

string

The name of the reference. Must be of the form 'organizations/{org}/environments/{env}/references/{ref}'.

resourceName

string

The name of the referred resource. Only references to keystore resources are supported. Must be of the form 'organizations/{org}/environments/{env}/keystores/{ks}'.