{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:akamai-cprg/get-cpcodes":{"get":{"operationId":"cloud_akamai_cprg_get_cpcodes","summary":"List CP codes","description":"GET /cpcodes","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":"Identifies the contract to filter data by. Include this optional parameter to narrow down the results to a specific contract only.","schema":{"type":"string","description":"Identifies the contract to filter data by. Include this optional parameter to narrow down the results to a specific contract only."},"example":"{{contractId}}"},{"name":"groupId","in":"query","required":false,"description":"Identifies the access group to filter data by. Include this optional parameter to narrow down the results to a specific access group only.","schema":{"type":"string","description":"Identifies the access group to filter data by. Include this optional parameter to narrow down the results to a specific access group only."},"example":"{{groupId}}"},{"name":"productId","in":"query","required":false,"description":"Identifies the product or service to filter data by. Include this optional parameter to narrow down the results to a specific product only.","schema":{"type":"string","description":"Identifies the product or service to filter data by. Include this optional parameter to narrow down the results to a specific product only."},"example":"{{productId}}"},{"name":"cpcodeName","in":"query","required":false,"description":"The name of the CP code to filter data by. Include this optional parameter to narrow down the results to a specific CP code name only.","schema":{"type":"string","description":"The name of the CP code to filter data by. Include this optional parameter to narrow down the results to a specific CP code name only."},"example":"{{cpcodeName}}"},{"name":"accountSwitchKey","in":"query","required":false,"description":"For customers who manage more than one account, this [runs the operation from another…","schema":{"type":"string","description":"For customers who manage more than one account, this [runs the operation from another…"},"example":"{{accountSwitchKey}}"}],"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-cprg/get-cpcodes-watermark-limits":{"get":{"operationId":"cloud_akamai_cprg_get_cpcodes_watermark_limits","summary":"Get a water-mark limit","description":"GET /cpcodes/contracts/{contractId}/watermark-limits","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":true,"description":"The identifier for the contract for which you want to check water-mark limits.","schema":{"type":"string","description":"The identifier for the contract for which you want to check water-mark limits."},"example":"{{contractId}}"},{"name":"accountSwitchKey","in":"query","required":false,"description":"For customers who manage more than one account, this [runs the operation from another…","schema":{"type":"string","description":"For customers who manage more than one account, this [runs the operation from another…"},"example":"{{accountSwitchKey}}"}],"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-cprg/get-cpcode":{"get":{"operationId":"cloud_akamai_cprg_get_cpcode","summary":"Get a CP code","description":"GET /cpcodes/{cpcodeId}","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":"cpcodeId","in":"query","required":true,"description":"The identifier for the CP code.","schema":{"type":"integer","description":"The identifier for the CP code."},"example":"{{cpcodeId}}"},{"name":"accountSwitchKey","in":"query","required":false,"description":"For customers who manage more than one account, this [runs the operation from another…","schema":{"type":"string","description":"For customers who manage more than one account, this [runs the operation from another…"},"example":"{{accountSwitchKey}}"}],"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-cprg/put-cpcode":{"post":{"operationId":"cloud_akamai_cprg_put_cpcode","summary":"Update a CP code","description":"PUT /cpcodes/{cpcodeId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["hostname","cpcodeId","body"],"properties":{"hostname":{"type":"string","description":"Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net"},"cpcodeId":{"type":"integer","description":"The identifier for the CP code."},"accountSwitchKey":{"type":"string","description":"For customers who manage more than one account, this [runs the operation from another…"},"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-cprg/get-reporting-groups":{"get":{"operationId":"cloud_akamai_cprg_get_reporting_groups","summary":"List reporting groups","description":"GET /reporting-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":"Identifies the contract to filter data by. Include this optional parameter to narrow down the results to a specific contract only.","schema":{"type":"string","description":"Identifies the contract to filter data by. Include this optional parameter to narrow down the results to a specific contract only."},"example":"{{contractId}}"},{"name":"groupId","in":"query","required":false,"description":"Identifies the access group to filter data by. Include this optional parameter to narrow down the results to a specific access group only.","schema":{"type":"string","description":"Identifies the access group to filter data by. Include this optional parameter to narrow down the results to a specific access group only."},"example":"{{groupId}}"},{"name":"reportingGroupName","in":"query","required":false,"description":"The name of the reporting group to filter data by. Include this optional parameter to narrow down the results to a specific reporting…","schema":{"type":"string","description":"The name of the reporting group to filter data by. Include this optional parameter to narrow down the results to a specific reporting…"},"example":"{{reportingGroupName}}"},{"name":"cpcodeId","in":"query","required":false,"description":"Identifies the CP code to filter data by. Include this optional parameter to narrow down the results to a specific CP code only.","schema":{"type":"string","description":"Identifies the CP code to filter data by. Include this optional parameter to narrow down the results to a specific CP code only."},"example":"{{cpcodeId}}"},{"name":"accountSwitchKey","in":"query","required":false,"description":"For customers who manage more than one account, this [runs the operation from another…","schema":{"type":"string","description":"For customers who manage more than one account, this [runs the operation from another…"},"example":"{{accountSwitchKey}}"}],"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-cprg/post-reporting-groups":{"post":{"operationId":"cloud_akamai_cprg_post_reporting_groups","summary":"Create a reporting group","description":"POST /reporting-groups","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"},"accountSwitchKey":{"type":"string","description":"For customers who manage more than one account, this [runs the operation from another…"},"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-cprg/get-reporting-groups-watermark-limits":{"get":{"operationId":"cloud_akamai_cprg_get_reporting_groups_watermark_limits","summary":"Get a water-mark limit for reporting groups","description":"GET /reporting-groups/contracts/{contractId}/watermark-limits","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":true,"description":"The identifier for the contract for which you want to check water-mark limits.","schema":{"type":"string","description":"The identifier for the contract for which you want to check water-mark limits."},"example":"{{contractId}}"},{"name":"accountSwitchKey","in":"query","required":false,"description":"For customers who manage more than one account, this [runs the operation from another…","schema":{"type":"string","description":"For customers who manage more than one account, this [runs the operation from another…"},"example":"{{accountSwitchKey}}"}],"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-cprg/get-reporting-group":{"get":{"operationId":"cloud_akamai_cprg_get_reporting_group","summary":"Get a reporting group","description":"GET /reporting-groups/{reportingGroupId}","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":"reportingGroupId","in":"query","required":true,"description":"The identifier for the reporting group.","schema":{"type":"integer","description":"The identifier for the reporting group."},"example":"{{reportingGroupId}}"},{"name":"accountSwitchKey","in":"query","required":false,"description":"For customers who manage more than one account, this [runs the operation from another…","schema":{"type":"string","description":"For customers who manage more than one account, this [runs the operation from another…"},"example":"{{accountSwitchKey}}"}],"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-cprg/put-reporting-group":{"post":{"operationId":"cloud_akamai_cprg_put_reporting_group","summary":"Update a reporting group","description":"PUT /reporting-groups/{reportingGroupId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["hostname","reportingGroupId","body"],"properties":{"hostname":{"type":"string","description":"Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net"},"reportingGroupId":{"type":"integer","description":"The identifier for the reporting group."},"accountSwitchKey":{"type":"string","description":"For customers who manage more than one account, this [runs the operation from another…"},"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-cprg/delete-reporting-group":{"post":{"operationId":"cloud_akamai_cprg_delete_reporting_group","summary":"Delete a reporting group","description":"DELETE /reporting-groups/{reportingGroupId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["hostname","reportingGroupId"],"properties":{"hostname":{"type":"string","description":"Your API client's host from Akamai Control Center, for example https://akab-xxxx.luna.akamaiapis.net"},"reportingGroupId":{"type":"integer","description":"The identifier for the reporting group."},"accountSwitchKey":{"type":"string","description":"For customers who manage more than one account, this [runs the operation from another…"}}}}}},"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-cprg/get-reporting-group-products":{"get":{"operationId":"cloud_akamai_cprg_get_reporting_group_products","summary":"List products within a reporting group","description":"GET /reporting-groups/{reportingGroupId}/products","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":"reportingGroupId","in":"query","required":true,"description":"The identifier for the reporting group.","schema":{"type":"integer","description":"The identifier for the reporting group."},"example":"{{reportingGroupId}}"},{"name":"accountSwitchKey","in":"query","required":false,"description":"For customers who manage more than one account, this [runs the operation from another…","schema":{"type":"string","description":"For customers who manage more than one account, this [runs the operation from another…"},"example":"{{accountSwitchKey}}"}],"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"}}}}}}}