ApigeeAliases.

GetApiProxy(ICakeContext, string, string, GetApiProxySettings) Method

Summary

Retrieve API proxy metadata such as the list of revisions and when the proxy was created.
Assembly
Cake.Apigee.dll
Namespace
Cake.Apigee
Containing Type
ApigeeAliases

Syntax

public static ApiProxy GetApiProxy(this ICakeContext ctx, string orgName, string proxyName, GetApiProxySettings settings = null)

Examples

Cake task:

 var orgName = "myorg";
 var apigeeCredentials = new Credentials
 {
    Username = "[email protected]",
    Password = "mypassword"
 };

 var proxyMetadata = GetApiProxy(
                    orgName,
                    "myapi",
                    new GetApiProxySettings { Credentials = apigeeCredentials });

Attributes

Type Description
CakeMethodAliasAttribute

Parameters

Name Type Description
ctx ICakeContext The Cake context.
orgName string Your org name as shown in Apigee.
proxyName string Name of the proxy.
settings GetApiProxySettings The settings such as authentication credentials.

Return Value

Type Description
ApiProxy The proxy metadata.