{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:akamai-datastream-config-api/get-dataset-fields":{"get":{"operationId":"cloud_akamai_datastream_config_api_get_dataset_fields","summary":"List data set fields","description":"GET /log/datasets-fields","tags":["cloud"],"parameters":[{"name":"hostname","in":"query","required":true,"description":"Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net","schema":{"type":"string","description":"Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net"}},{"name":"productId","in":"query","required":false,"description":"Uniquely identifies the product, and allows listing data sets available for that product. In the [List data set…","schema":{"type":"string","description":"Uniquely identifies the product, and allows listing data sets available for that product. In the [List data set…"},"example":"{{productId}}"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:akamai-datastream-config-api/get-groups":{"get":{"operationId":"cloud_akamai_datastream_config_api_get_groups","summary":"List groups","description":"GET /log/groups","tags":["cloud"],"parameters":[{"name":"hostname","in":"query","required":true,"description":"Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net","schema":{"type":"string","description":"Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net"}},{"name":"contractId","in":"query","required":false,"description":"Uniquely identifies the contract that belongs to a group.","schema":{"type":"string","description":"Uniquely identifies the contract that belongs to a group."},"example":"{{contractId}}"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:akamai-datastream-config-api/get-group-properties":{"get":{"operationId":"cloud_akamai_datastream_config_api_get_group_properties","summary":"List properties by group","description":"GET /log/groups/{groupId}/properties","tags":["cloud"],"parameters":[{"name":"hostname","in":"query","required":true,"description":"Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net","schema":{"type":"string","description":"Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net"}},{"name":"groupId","in":"query","required":true,"description":"Uniquely identifies the group that can access the product.","schema":{"type":"integer","description":"Uniquely identifies the group that can access the product."},"example":"{{groupId}}"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:akamai-datastream-config-api/get-streams":{"get":{"operationId":"cloud_akamai_datastream_config_api_get_streams","summary":"List streams","description":"GET /log/streams","tags":["cloud"],"parameters":[{"name":"hostname","in":"query","required":true,"description":"Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net","schema":{"type":"string","description":"Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net"}},{"name":"groupId","in":"query","required":false,"description":"Uniquely identifies the group that can access the product.","schema":{"type":"integer","description":"Uniquely identifies the group that can access the product."},"example":"{{groupId}}"},{"name":"propertyName","in":"query","required":false,"description":"Uniquely identifies the property. Enter up to five comma-delimited property names to get streams for specific properties.","schema":{"type":"string","description":"Uniquely identifies the property. Enter up to five comma-delimited property names to get streams for specific properties."},"example":"{{propertyName}}"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:akamai-datastream-config-api/post-stream":{"post":{"operationId":"cloud_akamai_datastream_config_api_post_stream","summary":"Create a stream","description":"POST /log/streams","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["hostname","body"],"properties":{"hostname":{"type":"string","description":"Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net"},"activate":{"type":"boolean","default":false,"description":"Activates the stream at the time of the request, `false` by default. When you [Edit a…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:akamai-datastream-config-api/get-streams-metrics":{"get":{"operationId":"cloud_akamai_datastream_config_api_get_streams_metrics","summary":"View upload metrics","description":"GET /log/streams/metrics","tags":["cloud"],"parameters":[{"name":"hostname","in":"query","required":true,"description":"Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net","schema":{"type":"string","description":"Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net"}},{"name":"start","in":"query","required":true,"description":"Specifies the beginning of the time range for the metrics in the ISO 8601 format. Set this no more than seven days before the `end` date.","schema":{"type":"string","description":"Specifies the beginning of the time range for the metrics in the ISO 8601 format. Set this no more than seven days before the `end` date."},"example":"{{start}}"},{"name":"end","in":"query","required":true,"description":"Specifies the end of the time range for the metrics in the ISO 8601 format. Set this no more than seven days after the `start` date.","schema":{"type":"string","description":"Specifies the end of the time range for the metrics in the ISO 8601 format. Set this no more than seven days after the `start` date."},"example":"{{end}}"},{"name":"streamId","in":"query","required":false,"description":"Uniquely identifies the stream. Set the `streamId` to get metrics for a specific stream, or `groupId` for all streams belonging to that…","schema":{"type":"integer","description":"Uniquely identifies the stream. Set the `streamId` to get metrics for a specific stream, or `groupId` for all streams belonging to that…"},"example":"{{streamId}}"},{"name":"groupId","in":"query","required":false,"description":"Set the `groupId` to get metrics for all streams belonging to that group, or `streamId` for a specific stream. If both are omitted, this…","schema":{"type":"integer","description":"Set the `groupId` to get metrics for all streams belonging to that group, or `streamId` for a specific stream. If both are omitted, this…"},"example":"{{groupId}}"},{"name":"aggregationInterval","in":"query","required":false,"description":"__Enum__ Specifies the time interval for metrics aggregation, either 5 minutes, an hour, or 24 hours. If omitted, this operation returns…","schema":{"type":"string","enum":["FIVE_MINUTE","HOUR","DAY"],"default":"HOUR","description":"__Enum__ Specifies the time interval for metrics aggregation, either 5 minutes, an hour, or 24 hours. If omitted, this operation returns…"},"example":"{{aggregationInterval}}"},{"name":"includeDetails","in":"query","required":false,"description":"Set to `true` or omit to get detailed metrics. If set to `false`, this operation returns only the `timestamp`, `streamId`,…","schema":{"type":"boolean","default":true,"description":"Set to `true` or omit to get detailed metrics. If set to `false`, this operation returns only the `timestamp`, `streamId`,…"},"example":"{{includeDetails}}"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:akamai-datastream-config-api/get-stream":{"get":{"operationId":"cloud_akamai_datastream_config_api_get_stream","summary":"Get a stream","description":"GET /log/streams/{streamId}","tags":["cloud"],"parameters":[{"name":"hostname","in":"query","required":true,"description":"Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net","schema":{"type":"string","description":"Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net"}},{"name":"streamId","in":"query","required":true,"description":"Uniquely identifies the stream.","schema":{"type":"integer","description":"Uniquely identifies the stream."},"example":"{{streamId}}"},{"name":"version","in":"query","required":false,"description":"Identifies the version of the stream. If omitted, the operation returns the latest version of the stream.","schema":{"type":"integer","description":"Identifies the version of the stream. If omitted, the operation returns the latest version of the stream."},"example":"{{version}}"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:akamai-datastream-config-api/put-stream":{"post":{"operationId":"cloud_akamai_datastream_config_api_put_stream","summary":"Edit a stream","description":"PUT /log/streams/{streamId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["hostname","streamId","body"],"properties":{"hostname":{"type":"string","description":"Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net"},"streamId":{"type":"integer","description":"Uniquely identifies the stream."},"activate":{"type":"boolean","default":false,"description":"Activates the stream at the time of the request, `false` by default. When you [Edit a…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:akamai-datastream-config-api/patch-stream":{"post":{"operationId":"cloud_akamai_datastream_config_api_patch_stream","summary":"Patch a stream","description":"PATCH /log/streams/{streamId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["hostname","streamId","body"],"properties":{"hostname":{"type":"string","description":"Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net"},"streamId":{"type":"integer","description":"Uniquely identifies the stream."},"activate":{"type":"boolean","default":false,"description":"Activates the stream at the time of the request, `false` by default. When you [Edit a…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:akamai-datastream-config-api/delete-stream":{"post":{"operationId":"cloud_akamai_datastream_config_api_delete_stream","summary":"Delete a stream","description":"DELETE /log/streams/{streamId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["hostname","streamId"],"properties":{"hostname":{"type":"string","description":"Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net"},"streamId":{"type":"integer","description":"Uniquely identifies the stream."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:akamai-datastream-config-api/post-stream-activate":{"post":{"operationId":"cloud_akamai_datastream_config_api_post_stream_activate","summary":"Activate a stream","description":"POST /log/streams/{streamId}/activate","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["hostname","streamId"],"properties":{"hostname":{"type":"string","description":"Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net"},"streamId":{"type":"integer","description":"Uniquely identifies the stream."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:akamai-datastream-config-api/get-stream-activation-history":{"get":{"operationId":"cloud_akamai_datastream_config_api_get_stream_activation_history","summary":"View activation history","description":"GET /log/streams/{streamId}/activation-history","tags":["cloud"],"parameters":[{"name":"hostname","in":"query","required":true,"description":"Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net","schema":{"type":"string","description":"Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net"}},{"name":"streamId","in":"query","required":true,"description":"Uniquely identifies the stream.","schema":{"type":"integer","description":"Uniquely identifies the stream."},"example":"{{streamId}}"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:akamai-datastream-config-api/post-stream-deactivate":{"post":{"operationId":"cloud_akamai_datastream_config_api_post_stream_deactivate","summary":"Deactivate a stream","description":"POST /log/streams/{streamId}/deactivate","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["hostname","streamId"],"properties":{"hostname":{"type":"string","description":"Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net"},"streamId":{"type":"integer","description":"Uniquely identifies the stream."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:akamai-datastream-config-api/get-stream-history":{"get":{"operationId":"cloud_akamai_datastream_config_api_get_stream_history","summary":"View history","description":"GET /log/streams/{streamId}/history","tags":["cloud"],"parameters":[{"name":"hostname","in":"query","required":true,"description":"Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net","schema":{"type":"string","description":"Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net"}},{"name":"streamId","in":"query","required":true,"description":"Uniquely identifies the stream.","schema":{"type":"integer","description":"Uniquely identifies the stream."},"example":"{{streamId}}"},{"name":"startVersion","in":"query","required":false,"description":"Specifies the first stream version in the `startVersion` to `endVersion` range you want to fetch stream history details for. The…","schema":{"type":"integer","default":1,"description":"Specifies the first stream version in the `startVersion` to `endVersion` range you want to fetch stream history details for. The…"},"example":"{{startVersion}}"},{"name":"endVersion","in":"query","required":false,"description":"Specifies the last stream version in the range you want to fetch stream history details for. The `endVersion` needs to be greater than…","schema":{"type":"integer","default":1,"description":"Specifies the last stream version in the range you want to fetch stream history details for. The `endVersion` needs to be greater than…"},"example":"{{endVersion}}"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}