Was this Helpful?

API Platform Base Path: https://api.enterprise.apigee.com/v1/o/{org_name}

API Resource Path: /resourcefiles
A files containing executable code or definitions used by API policies to enable custom behavior and extensibility
Resource files are executable code or other types of assets (for example XSLT) that are used by API proxies at runtime. Resource files can be stored at one of three levels:
  • API proxy: Available to any policies in an API proxy.
  • Environment: Available to any policies in any API proxy deployed in the environment.
  • Organization: Available to any API proxy deployed in any environment in an organization.

Resource files are resolved by name. Apigee Edge resolves resource files from most specific (API proxy) to the most general (organization).

This enables you to store generic code that provides utility processing at the organization level. This provides for greater maintainability, since generic code is not repeated across multiple API proxies.

A good example of code that might be scoped to the organization is a library to do Base64 encoding.

The following list shows the list of supported resource types and their associated directory name:

  • jsc: JavaScripts
  • java: JAR files
  • py: Python scripts
  • node: Node.js files, including the main Node.js file, related source files, and module dependencies
  • wsdl: Web service description language files
  • xsd: XML schemas
  • xsl: XSLT files
Import a resource file for an API proxy Detail
/organizations/{org_name}/apis/{api_name}/revisions/{revision_number}/resourcefiles
Verb: POST
Description: imports and creates a resource file for an API proxy
Media types:
application/octet-stream
Auth: Basic Auth
Import a resource file for an organization Detail
/organizations/{org_name}/resourcefiles
Verb: POST
Description: imports and creates a resource file for an organization
Media types:
application/octet-stream
Auth: Basic Auth
Import a resource file for an environment Detail
/organizations/{org_name}/environments/{env_name}/resourcefiles
Verb: POST
Description: imports and creates a resource file for an environment
Media types:
application/octet-stream
Auth: Basic Auth
Delete a resource file from an API proxy Detail
/apis/{api_name}/revisions/{revision_number}/resourcefiles/{resource_type}/{resource_name}
Verb: DELETE
Description: Deletes a resource file from an API proxy
Auth: Basic Auth
Delete a resource file from an organization Detail
/resourcefiles/{resource_type}/{resource_name}
Verb: DELETE
Description: Deletes a resource file from an organization
Auth: Basic Auth
Delete a resource file from an environment Detail
/environments/{env_name}/resourcefiles/{resource_type}/{resource_name}
Verb: DELETE
Description: Deletes a resource file from an environment
Auth: Basic Auth
Get a resource file for an API Detail
/apis/{api_name}/revisions/{revision_number}/resourcefiles/{resource_type}/{resource_name}
Verb: GET
Description: Gets the body of a resource from an API proxy.
Media types:
application/json
text/xml
Auth: Basic Auth
Get a resource file for an organization Detail
/resourcefiles/{resource_type}/{resource_name}
Verb: GET
Description: Gets the body of a resource from an organization.
Media types:
application/json
text/xml
Auth: Basic Auth
Get a resource file for an environment Detail
/environments/{env_name}/resourcefiles/{resource_type}/{resource_name}
Verb: GET
Description: Gets the body of a resource from an environment.
Media types:
application/json
text/xml
Auth: Basic Auth
List resource files for an API Detail
/apis/{api_name}/revisions/{revision_number}/resourcefiles
Verb: GET
Description: This method lists resource files available for an API proxy
Media types:
application/json
text/xml
Auth: Basic Auth
List resource files for an organization Detail
/resourcefiles
Verb: GET
Description: This method lists resource files available for an organization
Media types:
application/json
text/xml
Auth: Basic Auth
List resource files for an environment Detail
/environments/{env_name}/resourcefiles
Verb: GET
Description: This method lists resource files available for an environment
Media types:
application/json
text/xml
Auth: Basic Auth

 

Help or comments?

  • Something's not working: See Apigee Support
  • Something's wrong with the docs: Click Send Feedback in the lower right.
    (Incorrect? Unclear? Broken link? Typo?)