This pageapplies toApigee andApigee hybrid.

View Apigee Edge documentation.

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.

Resource types

The following table summarizes the resource types:

Where resources are stored

You can store resources to the following locations. You can't store resource files in anorganization.

• 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 or API.
• Environment: When stored in an environment (for example,test orprod), resources are available to any API proxy deployed in the same environment.

The environment repository is available at the following URI, as described by theList resource files API and later inManage resources using the API:/organizations/$ORG/environments/$ENV/resourcefiles

/organizations/$ORG/environments/test/resourcefiles/jsc

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

curl"http://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/resourcefiles?name={jar_file}&type=java"\-XPOST\-H"Authorization: Bearer $TOKEN"\-H"Content-Type: application/octet-stream"\--data-binary@{jar_file}

curl"http://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/resourcefiles?name={jar_file}&type=java"\-XPOST\-H"Authorization: Bearer $TOKEN"\-H"Content-Type: application/octet-stream"\-T"{jar_file}"

curl"http://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/resourcefiles?name={jar_file}&type=java"\-XPOST\-H"Authorization: Bearer $TOKEN"\-H"Content-Type: application/octet-stream"\-F"file=@{jar_file}"

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

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

Create a resource using the UI

Update a resource using the UI

Update a resource scoped to an API proxy revisiononly if the revision has not been deployed. After an API proxy revision is deployed, it is immutable.

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 underResources, 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

Delete a resource scoped to an API proxy revisiononly if the revision has not been deployed. After an API proxy revision is deployed, it is immutable.

To delete 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 orenvironment, as described in the following sections.

Create resources scoped to an API proxy revision using the API

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 API proxy
   • Update API proxy revision

Create resources scoped to an environment using the API

Create resources that are scoped 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://apigee.googleapis.com/v1/organizations/myorg/environments/test/resourcefiles?name=pathSetter.js&type=jsc  -H "Authorization: Bearer $TOKEN" \  -H "Content-type:application/octet-stream" \  -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");'

Where$TOKEN is set to your OAuth 2.0 access token, as described inObtaining an OAuth 2.0 access token. For information about thecurl options used in this example, seeUsing curl. For a description of environment variables you can use, seeSettingenvironment variables for Apigee API requests.

The following example shows how to upload the resource as a file from your local machine. It's important to use-F for the binary upload in curl in order for the environment- or organization-scoped JavaScript files to be accessible by the JavaScript policy.

curl -X POST https://apigee.googleapis.com/v1/organizations/myorg/environments/test/resourcefiles?name=pathSetter.js&type=jsc  -H "Authorization: Bearer $TOKEN" \  -H "Content-type:multipart/form-data" \  -F file=@pathSetter.js

The following provides an example of the response:

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

curl -X GET https://apigee.googleapis.com/v1/organizations/myorg/environments/test/resourcefiles  -H "Authorization: Bearer $TOKEN"

Where$TOKEN is set to your OAuth 2.0 access token, as described inObtaining an OAuth 2.0 access token. For information about thecurl options used in this example, seeUsing curl. For a description of environment variables you can use, seeSettingenvironment variables for Apigee API requests.

For more information, seeList environment resource files API.

The following provides an example of the response.

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

View the contents of a resource using the API

To view the contents of a resource in an environment using the API, issue aGET request to the following resource:/organizations/$ORG/environments/$ENV/resourcefiles/$TYPE/$NAME

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

curl -X GET https://apigee.googleapis.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js  -H "Authorization: Bearer $TOKEN"

Where$TOKEN is set to your OAuth 2.0 access token, as described inObtaining an OAuth 2.0 access token. For information about thecurl options used in this example, seeUsing curl. For a description of environment variables you can use, seeSettingenvironment variables for Apigee API requests.

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 orenvironment, as described in the following sections.

Update resources scoped to an API proxy revision using the API

1. Download the API proxy configuration bundle using theGet API proxy revision 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 API proxy configuration 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://apigee.googleapis.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js  -H "Authorization: Bearer $TOKEN" \  -H "Content-type:application/octet-stream" \  -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");'

Where$TOKEN is set to your OAuth 2.0 access token, as described inObtaining an OAuth 2.0 access token. For information about thecurl options used in this example, seeUsing curl. For a description of environment variables you can use, seeSettingenvironment variables for Apigee API requests.

The following example shows how to update the resource file using a file from your local machine. It's important to use-F for the binary upload in curl in order for the environment- or organization-scoped JavaScript files to be accessible by the JavaScript policy.

curl -X PUT https://apigee.googleapis.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js  -H "Authorization: Bearer $TOKEN" \  -H "Content-type:multipart/form-data" \  -F file=@pathSetter.js

The following provides an example of the response:

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

Delete resources using the API

Delete resource scoped to anAPI proxy revision orenvironment, as described in the following sections.

Delete resources scoped to an API proxy revision using the API

1. Download the API proxy configuration bundle using theGet API proxy revision 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 API proxy configuration 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://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/resourcefiles/$TYPE/$NAME

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

curl -X DELETE https://apigee.googleapis.com/v1/organizations/my-organization/environments/test/resourcefiles/jsc/pathSetter.js \  -H "Authorization: Bearer $TOKEN"

Where$TOKEN is set to your OAuth 2.0 access token, as described inObtaining an OAuth 2.0 access token. For information about thecurl options used in this example, seeUsing curl. For a description of environment variables you can use, seeSettingenvironment variables for Apigee API requests.

For more information, seeDelete resource file API.

The following provides an example of the response.

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

Access the resource

How you access the resource depends on theresource type. For more information, refer to thePolicy reference overview.

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.