Proxy
A proxy configuration
Properties
Proxy
| Name | Type | Format | Description |
|---|---|---|---|
| id | string | The proxy identifier as a 128 bit GUID. | |
| projectId | string | The project api identifier | |
| name | string | The proxy name | |
| description | string | An optional description for the proxy | |
| endpoints | object | Proxy endpoint | Endpoint configurations keyed by language |
| version | object | version | The version details for the proxy resource |
Proxy endpoint
| Name | Type | Format | Description |
|---|---|---|---|
| server | string | The hostname of the server to proxy to | |
| ssl | bool | Specify whether the proxied server communication uses SSL/TLS | |
| headers | object | Header key-value pairs that should be added with each request |
Remarks
An asterisk can be specified as the key for an endpoint to handle all languages excluding any endpoint explicitly declared with a language. If no asterisk-keyed endpoint is specified then only the languages provided will be proxied.
If no host is provided for a URI that includes the domain, then the host header is automatically added on creation.
Example
{
"id": "7622b5f7-e245-4226-9e64-3aeafa930eae",
"projectId": "movieDb",
"name": "Thrillers section",
"description": "Proxies current website thrillers section",
"endpoints": {
"*": {
"server": "10.65.18.4",
"ssl": true,
"headers": {
"host": "www.moviedb-oldsite.com"
}
},
"fr-FR": {
"server": "10.65.18.4",
"ssl": true,
"headers": {
"host": "www.moviedb.fr"
}
}
},
"version": {
"versionNo": "2.0",
"created": "2020-02-13T10:15:12.1973648+01:00",
"createdBy": "t.durden",
"modified": "2020-02-13T10:15:12.1973648+01:00",
"modifiedBy": "t.durden",
"published": "2020-02-13T10:15:12.1973648+01:00",
"publishedBy": "t.durden"
}
}