You're viewingApigee Edge documentation.
Go to theApigee X documentation.info

Understand and manage resources, as described in the following sections.

About resources

Many policy types rely onresources. Resources are the files that implement the code or configuration to be executed by a policy when attached to an API proxy. In some cases, as with JavaScript and JavaCallout, a policy simply defines an attachment point in an API proxy where some code should execute. The JavaScript or JavaCallout policy is a pointer to a resource.

The following sample JavaScript sets the HTTP request path to the value of theproxy.basepath variable.

request.headers["RequestPath"] = context.getVariable("proxy.basepath");

Resource types

The following table summarizes the resource types:

Where resources are stored

Resources can be stored in one of the following three locations:

• API proxy revision: Resources are available only to the API proxy revisions in which the resources are included. For example, you might include a JavaScript resource with revision 1 of an API proxy, then change the implementation to use a Python script in revision 2 of the proxy. Revision 1 has access to only the JavaScript resource, and revision 2 has access to only the Python resource.Note: In the UI, resources scoped to an API proxy revision are listed in the Resources section of the Navigation pane whether you added them with the UI orAPI.
• Environment: When stored in an environment (for example,test orprod), resources are available to any API proxy deployed in the same environment.
• Organization: When stored in an organization, resources are available to any API proxy deployed in any environment.

The repositories are available at the following URIs, as described by theResource files API and later inManage resources using the API:

• Organization:/organizations/{org}/resourcefiles
• Environment:/organizations/{org}/environments/{env}/resourcefiles
• API Proxy:/organizations/{org}/apis/{api}/revisions/{rev}/resources

The following table shows the methods you can use to create, update,and delete resources for each repository:

For example, all JavaScript files available to thetest environment are stored in the following repository and are available to any API proxy running in thetest environment:

/organizations/{org}/environments/test/resourcefiles/jsc

Resource name resolution

Edge resolves resource names from the most specific to the most general scope. Resource names are resolved "up the chain", from the API proxy revision level, to the environment level, to the organization level (Edge only).

Let's say that you have populated the same resource in two different repositories — the API proxy revision and theprod environment.

Consider the API proxy that is configured with the following Policy:

<Javascript name='PathSetterPolicy' timeLimit='200'>    <ResourceURL>jsc://pathSetter.js</ResourceURL></Javascript>

The policy reference cannot explicitly resolve to a repository. The first resource at the most granular scope whose name matches the resource name in the policy is resolved.

So, when the API proxy is deployed in the environmentprod, the policy will resolve to the environment-scopedpathSetter.js resource.

When deployed in the environmenttest, the Policy will resolve to theAPI proxy revision-scoped resource, because the environment-scoped resource is in theprodenvironment, not thetest environment.

Java resource guidelines

You can add compiled Java resources as JAR files using multiple options in curl, such as-T,--data-binary, or-F option (not the-d option). For example:

curl "http://{mgmt_server}:{port}/v1/organizations/{org}/environments/{env}/resourcefiles?name={jar_file}&type=java" \  -X POST \  --data-binary @{jar_file} \  -H "Content-Type: application/octet-stream" \  -uemail:password

curl -v "http://{mgmt_server}:{port}/v1/organizations/{org}/environments/{env}/resourcefiles?name={jar_file}&type=java"  -X POST \  -H "Content-Type: application/octet-stream" \  -T "{jar_file}" \  -uemail:password

curl -v "http://{mgmt_server}:{port}/v1/organizations/{org}/environments/{env}/resourcefiles?name={jar_file}&type=java"  -X POST \  -H "Content-Type: application/multipart/form-data" \  -F "file=@{jar_file}" \  -uemail:password

• Java best practices:Best practices for API proxy design and development
• Java cookbook example:XSL Transform policy

Node.js resource guidelines

Deprecated feature: Thetraditional Node.js support on Apigee Edge for Public Cloud is deprecated. For details on the deprecation, see theDeprecations and retirements page. This feature will be retired in the future.

If you are using Apigee Edge for Public Cloud, Apigee recommends that you useHosted Targets for new Node.js development and deployment to Apigee Edge. For information on migrating existing proxies that use Apigee's traditional Node.js deployment approach, seeMigrating an existing Node.js proxy to a Hosted Targets proxy.

When you reference a Node.js script in an API proxy, you do so with the<ResourceURL> element in the API proxy'sTargetEndpoint configuration, as described inAdding Node.js to an existing API proxy. For example:

<ScriptTarget>    <ResourceURL>node://hello-world.js</ResourceURL></ScriptTarget>

That Node.js script and all supporting modules must reside at the API proxy revision scope (in the proxy bundle's/resources/node directory). In the API proxy editor, adding the Node.js resource to the Scripts section accomplishes this. So does using the API (import andupdate) to store the resource at the API proxy revision scope.

Manage resources using the UI

Manage resources scoped to anAPI proxy revision using the UI, as described in the following sections.

View resources using the UI

To view the resources scoped to an API proxy revision:

1. Sign in toapigee.com/edge.

2. SelectDevelop > API Proxies in the left navigation bar.
3. Select an API proxy in the list for which you want to create a resource.
   The API proxy editor opens and the Overview tab is displayed, by default.
4. Click theDevelop tab.
5. Select the revision in theRevision drop-down, if required.

   The resources scoped to the API proxy revision are listed in theResources section in the Navigator view.

   

Create a resource using the UI

To create resources scoped to an API proxy revision using the UI:

1. View the resources scoped to the API proxy revision.
2. Click+ in the Resources section in the Navigator view to open the New Resource dialog.
3. Enter the following:

   Field	Description
   Source	Select to create a new file or import a file.
   File Type	Select aresource type from the drop-down list.
   File Name	Name of the file. The filename extension must be valid for the selected file type.

Update a resource using the UI

To update a resource scoped to an API proxy revision using the UI:

1. View the resources scoped to the API proxy revision.
2. In the Navigator view under Resources, click the resource that you want to update.
   Note: For JAR files, position your cursor over the resource that you want to edit and click.
3. Update the resource, as required.
   Note: After uploading a new JAR file, clickUpdate.

Delete a resource using the UI

To detele a resource scoped to an API proxy revision using the UI:

1. View the resources scoped to the API proxy revision.
2. In the Navigator view under Resources, position your cursor over the resource that you want to delete to display the actions menu.
3. Click.
4. ClickDelete to confirm the action.

Manage resources using the API

Manage resources using the API, as described in the following sections.

Create resources using the API

Create resources that are scoped to anAPI proxy revision,environment, ororganization (Edge only), as described in the following sections.

Create resources scoped to an API proxy revision using the API

Create a resource scoped to an API proxy revision using the API by issuing aPOST request to the following resource:https://api.enterprise.apigee.com/v1/organizations/{org}/apis/{api}/revisions/{rev}/resourcefiles

Pass the following information with your request:

• Set thename query parameter to the name of the resource
• Set thetype query parameter to the requiredresource type
• Pass the contents of the resource file asapplication/octet-stream ormultipart/form-data)

curl -X POST https://api.enterprise.apigee.com/v1/organizations/myorg/apis/helloworld/revisions/1/resourcefiles?name=pathSetter.js&type=jsc  -H "Content-type:application/octet-stream" \  -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");' \  -uemail:password

curl -X POST https://api.enterprise.apigee.com/v1/organizations/myorg/apis/helloworld/revisions/1/resourcefiles?name=pathSetter.js&type=jsc  -H "Content-type:multipart/form-data" \  -F file=@pathSetter.js \  -uemail:password

{  "name": "pathSetter.js",  "type": "jsc"}

For more information, seeImport a resource file for an API proxy revision.

Alternatively, you can use the Update API proxy revision API, as follows:

1. Create the resource file.
2. Add the resource file to anAPI proxy configuration bundle.
3. Upload the bundle using one of the following APIs:
   • Create an API proxy
   • Update API proxy revision

Create resources scoped to an environment using the API

Create a JavaScript resource that is scoped to to an environment using the API by issuing aPOST request to the following resource:/organizations/{org}/environments/{env}/resourcefiles

Pass the following information with your request:

• Set thename query parameter to the name of the resource
• Set thetype query parameter to the requiredresource type
• Pass the contents of the resource file asapplication/octet-stream ormultipart/form-data)

curl -X POST https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles?name=pathSetter.js&type=jsc  -H "Content-type:application/octet-stream" \  -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");' \  -uemail:password

curl -X POST https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles?name=pathSetter.js&type=jsc  -H "Content-type:multipart/form-data" \  -F file=@pathSetter.js \  -uemail:password

{"name":"pathSetter.js","type":"jsc"}

• Set thename query parameter to the name of the resource
• Set thetype query parameter to type of resource file (seeResource types)
• Pass the contents of the resource file asapplication/octet-stream ormultipart/form-data)

For more information, seeImport a resource file for an organization.

View resources using the API

The following sections describe how to view resources using the API.

View all resources using the API

Using the API you can view resources scoped to anAPI proxy revision,environment, ororganization.

For example, to view resources for resources scoped to environment using the API, issue aGET request to the following resource:https://api.enterprise.apigee.com/v1/organizations/{org}/environments/{env}/resourcefiles

The following example lists all resources in thetest environment:

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/my-organization/environments/test/resourcefiles/{type}" \  -uemail:password

The following provides an example of the response.

{  "resourceFile": [{  "name" : "pathSetter.js",  "type" : "jsc"}  ]}

View the contents of a resource using the API

View the content of a resource using the API, as described in the following sections.

Using the API you can view resources scoped to anAPI proxy revision,environment, ororganization.

For example, to view the contents of a resource in an environment using the API, issue aGET request to the following resource:https://api.enterprise.apigee.com/v1/organizations/{org}/environments/{env}/resourcefiles/{type}/name

The following example lists the contents of thepathSetter.js JavaScript resource file in thetest environment:

curl -X GET https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js" \  -H "Accept: application/json" \  -uemail:password

The following provides an example of the response:

request.headers["RequestPath"] = context.getVariable("proxy.basepath");

Update resources using the API

Update resources that are scoped to anAPI proxy revision,environment, ororganization (Edge only), as described in the following sections.

Update resources scoped to an API proxy revision using the API

Update a resource scoped to an API proxy revision using the API by issuing aPUT request to the following resource:https://api.enterprise.apigee.com/v1/organizations/{org}/apis/{api}/revisions/{rev}/resourcefiles/{type}/{name}

Pass the contents of the resource file asapplication/octet-stream ormultipart/form-data)

curl -X PUT https://api.enterprise.apigee.com/v1/organizations/myorg/apis/helloworld/revisions/1/resourcefiles/jsc/pathSetter.js  -H "Content-type:application/octet-stream" \  -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");' \  -uemail:password

curl -X PUT https://api.enterprise.apigee.com/v1/organizations/myorg/apis/helloworld/revisions/1/resourcefiles/jsc/pathSetter.js  -H "Content-type:multipart/form-data" \  -F file=@pathSetter.js \  -uemail:password

{  "name": "pathSetter.js",  "type": "jsc"}

For more information, seeImport a resource file for an API proxy revision.

Alternatively, you can use the Update API proxy revision API, as follows:

1. Download the API proxy configuration bundle using theExport API proxy API with the following options:
   • Set theformat query parameter tobundle
   • Set theAccept header toapplication/zip
2. Update the resource file in theAPI proxy configuration bundle.
3. Upload the bundle using theUpdate API proxy revision API

Update resources scoped to an environment using the API

Update a resource that is scoped to to an environment using the API by issuing aPUT request to the following resource:/organizations/{org}/environments/{env}/resourcefiles/{type}/{name}

Pass the contents of the resource file asapplication/octet-stream ormultipart/form-data.

curl -X PUT https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js  -H "Content-type:application/octet-stream" \  -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");' \  -uemail:password

curl -X PUT https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js  -H "Content-type:multipart/form-data" \  -F file=@pathSetter.js \  -uemail:password

{"name":"pathSetter.js","type":"jsc"}

For more information, seeImport a resource file for an organization,

Delete resources using the API

Delete resource scoped to anAPI proxy revision,environment, ororganization (Edge only), as described in the following sections.

Delete resources scoped to an API proxy revision using the API

To delete a resource scoped to an API proxy revision using the API, issue aDELETE request to the following resource:https://api.enterprise.apigee.com/v1/organizations/{org}/apis/{api}/revisions/{rev}/resourcefiles/{type}/{name}

The following example deletes thepathSetter.js JavaScript resource file from revision 1 of the helloworld API proxy:

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/my-organization/apis/helloworld/revisions/1/resourcefiles/jsc/pathSetter.js" \  -uemail:password

The following provides an example of the response.

{  "name" : "pathSetter.js",  "type" : "jsc"}

Alternatively, you can use the Update API proxy revision API, as follows:

1. Download the API proxy configuration bundle using theExport API proxy API with the following options:
   • Set theformat query parameter tobundle
   • Set theAccept header toapplication/zip
2. Delete the resource file from theAPI proxy configuration bundle.
3. Upload the bundle using theUpdate API proxy revision API

Delete a resource scoped to an environment using the API

Delete a resource scoped to an environment using the API, as described in the following sections.

To delete a resource scoped to an environment using the API, issue aDELETE request to the following resource:https://api.enterprise.apigee.com/v1/organizations/{org}/environments/{env}/resourcefiles/{type}/{name}

The following example deletes thepathSetter.js JavaScript resource file from thetest environment:

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/my-organization/environments/test/resourcefiles/jsc/pathSetter.js" \  -uemail:password

The following provides an example of the response.

{  "name" : "pathSetter.js",  "type" : "jsc"}

Delete resources scoped to the organization using the API (Edge only)

To delete a resource that is scoped to an organization using the API, issue aDELETE request to the following resource:https://api.enterprise.apigee.comv1/organizations/{org}/resourcefiles/{type}/{name}

For more information, seeDelete a resource file from an organization.

Access the resource

How you access the resource depends on theresource type. For more information, refer to therelevant policy documentation.

The examples in this section demonstrate how to create and manage a JavaScript resource namedpathSetter.js to allow it to be referenced by policies of type JavaScript.

To attach the JavaScript to the Request PostFlow, create a policy calledPathSetterPolicy.xml that references the filepathSetter.js:

<Javascript name='PathSetterPolicy' timeLimit='200'>    <ResourceURL>jsc://pathSetter.js</ResourceURL></Javascript>

Then, reference the policy in the Endpoint configuration:

<PostFlow>  <Request>    <Step><Name>PathSetterPolicy</Name></Step>  </Request><PostFlow>

For more information, seeJavaScript policy.