Management API
Bundle service
OPA expects the service to expose an API endpoint that serves bundles. The bundle API allows clients to download bundles at an arbitrary URL (in combination with {service_path}. For example, using the configuration example below will fetch bundles from https//example.com/service/v1/somedir/bundle.tar.gz. The URL is constructed as follows:
https://example.com/service/v1/somedir/bundle.tar.gz
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^
services[0].url resource
Configuration example
services:
- name: acmecorp
url: https://example.com/service/v1
credentials:
bearer:
token: "bGFza2RqZmxha3NkamZsa2Fqc2Rsa2ZqYWtsc2RqZmtramRmYWxkc2tm"
bundles:
authz:
service: acmecorp
resource: somedir/bundle.tar.gz
persist: true
polling:
min_delay_seconds: 10
max_delay_seconds: 20
signing:
keyid: my_global_key
scope: read
get/{service_path}/{resource}
Request
- The document declares no server URL.
- Authnone required
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
service_pathstring required
The path to the required bundle
resourcestring required
The resource bundle (gzip tarball)
Response
Success. You will find a gzip file is in the response's message body
Changes
No recorded changes to this operation across all 2 revisions of this API.