This set of endpoints are used for proxying application server requests that are scoped to an individual project.

Endpoints

Proxy GET request to app server

Endpoint
get /projects/{projectId}/appProxy/{srcPath}
Description

Proxy a GET request to the a target app service if there is a matching App Proxy route for the specified source path. The response depends on the behavior of the target app service.

Path Parameters
  • projectId

    integer

    required

    Project ID

  • srcPath

    string

    required

    A path that matches one of the source paths in the project's App Proxy configuration.

Request Headers What's this?
  • Authorization

    required

    Must contain a user or project API key.

Proxy POST request to app server

Endpoint
post /projects/{projectId}/appProxy/{srcPath}
Description

Proxy a POST request to the a target app service if there is a matching App Proxy route for the specified source path. The request body and response depend on the behavior of the target app service.

Path Parameters
  • projectId

    integer

    required

    Project ID

  • srcPath

    string

    required

    A path that matches one of the source paths in the project's App Proxy configuration.

Request Headers What's this?
  • Authorization

    required

    Must contain a user or project API key.

Proxy PUT request to app server

Endpoint
put /projects/{projectId}/appProxy/{srcPath}
Description

Proxy a PUT request to the a target app service if there is a matching App Proxy route for the specified source path. The request body and response depend on the behavior of the target app service.

Path Parameters
  • projectId

    integer

    required

    Project ID

  • srcPath

    string

    required

    A path that matches one of the source paths in the project's App Proxy configuration.

Request Headers What's this?
  • Authorization

    required

    Must contain a user or project API key.

Proxy PATCH request to app server

Endpoint
patch /projects/{projectId}/appProxy/{srcPath}
Description

Proxy a PATCH request to the a target app service if there is a matching App Proxy route for the specified source path. The request body and response depend on the behavior of the target app service.

Path Parameters
  • projectId

    integer

    required

    Project ID

  • srcPath

    string

    required

    A path that matches one of the source paths in the project's App Proxy configuration.

Request Headers What's this?
  • Authorization

    required

    Must contain a user or project API key.

Proxy DELETE request to app server

Endpoint
delete /projects/{projectId}/appProxy/{srcPath}
Description

Proxy a DELETE request to the a target app service if there is a matching App Proxy route for the specified source path. The response depends on the behavior of the target app service.

Path Parameters
  • projectId

    integer

    required

    Project ID

  • srcPath

    string

    required

    A path that matches one of the source paths in the project's App Proxy configuration.

Request Headers What's this?
  • Authorization

    required

    Must contain a user or project API key.