{"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:azure-keyvault-administration/role-assignments-list-for-scope":{"get":{"operationId":"cloud_azure_keyvault_administration_role_assignments_list_for_scope","summary":"Gets role assignments for a scope.","description":"GET /{scope}/providers/Microsoft.Authorization/roleAssignments","tags":["cloud"],"parameters":[{"name":"vaultBaseUrl","in":"query","required":true,"description":"The base URL of the Key Vault instance (e.g. https://myvault.vault.azure.net/)","schema":{"type":"string","description":"The base URL of the Key Vault instance (e.g. https://myvault.vault.azure.net/)"}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"7.6","description":"The API version to use for this operation."}},{"name":"scope","in":"query","required":true,"description":"The scope of the role assignments.","schema":{"type":"string","description":"The scope of the role assignments."}},{"name":"$filter","in":"query","required":false,"description":"The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId…","schema":{"type":"string","description":"The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId…"}}],"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:azure-keyvault-administration/role-assignments-get":{"get":{"operationId":"cloud_azure_keyvault_administration_role_assignments_get","summary":"Get the specified role assignment.","description":"GET /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}","tags":["cloud"],"parameters":[{"name":"vaultBaseUrl","in":"query","required":true,"description":"The base URL of the Key Vault instance (e.g. https://myvault.vault.azure.net/)","schema":{"type":"string","description":"The base URL of the Key Vault instance (e.g. https://myvault.vault.azure.net/)"}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"7.6","description":"The API version to use for this operation."}},{"name":"scope","in":"query","required":true,"description":"The scope of the role assignment.","schema":{"type":"string","description":"The scope of the role assignment."}},{"name":"roleAssignmentName","in":"query","required":true,"description":"The name of the role assignment to get.","schema":{"type":"string","description":"The name of the role assignment to get."}}],"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:azure-keyvault-administration/role-assignments-create":{"post":{"operationId":"cloud_azure_keyvault_administration_role_assignments_create","summary":"Creates a role assignment.","description":"PUT /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["vaultBaseUrl","scope","roleAssignmentName","body"],"properties":{"vaultBaseUrl":{"type":"string","description":"The base URL of the Key Vault instance (e.g. https://myvault.vault.azure.net/)"},"api-version":{"type":"string","default":"7.6","description":"The API version to use for this operation."},"scope":{"type":"string","description":"The scope of the role assignment to create."},"roleAssignmentName":{"type":"string","description":"The name of the role assignment to create. It can be any valid GUID."},"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:azure-keyvault-administration/role-assignments-delete":{"post":{"operationId":"cloud_azure_keyvault_administration_role_assignments_delete","summary":"Deletes a role assignment.","description":"DELETE /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["vaultBaseUrl","scope","roleAssignmentName"],"properties":{"vaultBaseUrl":{"type":"string","description":"The base URL of the Key Vault instance (e.g. https://myvault.vault.azure.net/)"},"api-version":{"type":"string","default":"7.6","description":"The API version to use for this operation."},"scope":{"type":"string","description":"The scope of the role assignment to delete."},"roleAssignmentName":{"type":"string","description":"The name of the role assignment to delete."}}}}}},"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:azure-keyvault-administration/role-definitions-list":{"get":{"operationId":"cloud_azure_keyvault_administration_role_definitions_list","summary":"Get all role definitions that are applicable at scope and above.","description":"GET /{scope}/providers/Microsoft.Authorization/roleDefinitions","tags":["cloud"],"parameters":[{"name":"vaultBaseUrl","in":"query","required":true,"description":"The base URL of the Key Vault instance (e.g. https://myvault.vault.azure.net/)","schema":{"type":"string","description":"The base URL of the Key Vault instance (e.g. https://myvault.vault.azure.net/)"}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"7.6","description":"The API version to use for this operation."}},{"name":"scope","in":"query","required":true,"description":"The scope of the role definition.","schema":{"type":"string","description":"The scope of the role definition."}},{"name":"$filter","in":"query","required":false,"description":"The filter to apply on the operation. Use atScopeAndBelow filter to search below the given scope as well.","schema":{"type":"string","description":"The filter to apply on the operation. Use atScopeAndBelow filter to search below the given scope as well."}}],"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:azure-keyvault-administration/role-definitions-get":{"get":{"operationId":"cloud_azure_keyvault_administration_role_definitions_get","summary":"Get the specified role definition.","description":"GET /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionName}","tags":["cloud"],"parameters":[{"name":"vaultBaseUrl","in":"query","required":true,"description":"The base URL of the Key Vault instance (e.g. https://myvault.vault.azure.net/)","schema":{"type":"string","description":"The base URL of the Key Vault instance (e.g. https://myvault.vault.azure.net/)"}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"7.6","description":"The API version to use for this operation."}},{"name":"scope","in":"query","required":true,"description":"The scope of the role definition to get. Managed HSM only supports '/'.","schema":{"type":"string","description":"The scope of the role definition to get. Managed HSM only supports '/'."}},{"name":"roleDefinitionName","in":"query","required":true,"description":"The name of the role definition to get.","schema":{"type":"string","description":"The name of the role definition to get."}}],"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:azure-keyvault-administration/role-definitions-create-or-update":{"post":{"operationId":"cloud_azure_keyvault_administration_role_definitions_create_or_update","summary":"Creates or updates a custom role definition.","description":"PUT /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["vaultBaseUrl","scope","roleDefinitionName","body"],"properties":{"vaultBaseUrl":{"type":"string","description":"The base URL of the Key Vault instance (e.g. https://myvault.vault.azure.net/)"},"api-version":{"type":"string","default":"7.6","description":"The API version to use for this operation."},"scope":{"type":"string","description":"The scope of the role definition to create or update. Managed HSM only supports '/'."},"roleDefinitionName":{"type":"string","description":"The name of the role definition to create or update. It can be any valid GUID."},"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:azure-keyvault-administration/role-definitions-delete":{"post":{"operationId":"cloud_azure_keyvault_administration_role_definitions_delete","summary":"Deletes a custom role definition.","description":"DELETE /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["vaultBaseUrl","scope","roleDefinitionName"],"properties":{"vaultBaseUrl":{"type":"string","description":"The base URL of the Key Vault instance (e.g. https://myvault.vault.azure.net/)"},"api-version":{"type":"string","default":"7.6","description":"The API version to use for this operation."},"scope":{"type":"string","description":"The scope of the role definition to delete. Managed HSM only supports '/'."},"roleDefinitionName":{"type":"string","description":"The name (GUID) of the role definition to delete."}}}}}},"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:azure-keyvault-administration/full-backup":{"post":{"operationId":"cloud_azure_keyvault_administration_full_backup","summary":"Creates a full backup using a user-provided SAS token to an Azure blob storage container.","description":"POST /backup","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["vaultBaseUrl","body"],"properties":{"vaultBaseUrl":{"type":"string","description":"The base URL of the Key Vault instance (e.g. https://myvault.vault.azure.net/)"},"api-version":{"type":"string","default":"7.6","description":"The API version to use for this operation."},"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:azure-keyvault-administration/full-backup-status":{"get":{"operationId":"cloud_azure_keyvault_administration_full_backup_status","summary":"Returns the status of full backup operation","description":"GET /backup/{jobId}/pending","tags":["cloud"],"parameters":[{"name":"vaultBaseUrl","in":"query","required":true,"description":"The base URL of the Key Vault instance (e.g. https://myvault.vault.azure.net/)","schema":{"type":"string","description":"The base URL of the Key Vault instance (e.g. https://myvault.vault.azure.net/)"}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"7.6","description":"The API version to use for this operation."}},{"name":"jobId","in":"query","required":true,"description":"The id returned as part of the backup request","schema":{"type":"string","description":"The id returned as part of the backup request"}}],"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:azure-keyvault-administration/selective-key-restore-operation":{"post":{"operationId":"cloud_azure_keyvault_administration_selective_key_restore_operation","summary":"Restores all key versions of a given key using user supplied SAS token pointing to a previously stored Azure…","description":"PUT /keys/{keyName}/restore","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["vaultBaseUrl","keyName","body"],"properties":{"vaultBaseUrl":{"type":"string","description":"The base URL of the Key Vault instance (e.g. https://myvault.vault.azure.net/)"},"api-version":{"type":"string","default":"7.6","description":"The API version to use for this operation."},"keyName":{"type":"string","description":"The name of the key to be restored from the user supplied backup"},"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:azure-keyvault-administration/pre-full-backup":{"post":{"operationId":"cloud_azure_keyvault_administration_pre_full_backup","summary":"Pre-backup operation for checking whether the customer can perform a full backup operation.","description":"POST /prebackup","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["vaultBaseUrl","body"],"properties":{"vaultBaseUrl":{"type":"string","description":"The base URL of the Key Vault instance (e.g. https://myvault.vault.azure.net/)"},"api-version":{"type":"string","default":"7.6","description":"The API version to use for this operation."},"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:azure-keyvault-administration/pre-full-restore-operation":{"post":{"operationId":"cloud_azure_keyvault_administration_pre_full_restore_operation","summary":"Pre-restore operation for checking whether the customer can perform a full restore operation.","description":"PUT /prerestore","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["vaultBaseUrl","body"],"properties":{"vaultBaseUrl":{"type":"string","description":"The base URL of the Key Vault instance (e.g. https://myvault.vault.azure.net/)"},"api-version":{"type":"string","default":"7.6","description":"The API version to use for this operation."},"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:azure-keyvault-administration/full-restore-operation":{"post":{"operationId":"cloud_azure_keyvault_administration_full_restore_operation","summary":"Restores all key materials using the SAS token pointing to a previously stored Azure Blob storage backup…","description":"PUT /restore","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["vaultBaseUrl","body"],"properties":{"vaultBaseUrl":{"type":"string","description":"The base URL of the Key Vault instance (e.g. https://myvault.vault.azure.net/)"},"api-version":{"type":"string","default":"7.6","description":"The API version to use for this operation."},"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:azure-keyvault-administration/restore-status":{"get":{"operationId":"cloud_azure_keyvault_administration_restore_status","summary":"Returns the status of restore operation","description":"GET /restore/{jobId}/pending","tags":["cloud"],"parameters":[{"name":"vaultBaseUrl","in":"query","required":true,"description":"The base URL of the Key Vault instance (e.g. https://myvault.vault.azure.net/)","schema":{"type":"string","description":"The base URL of the Key Vault instance (e.g. https://myvault.vault.azure.net/)"}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"7.6","description":"The API version to use for this operation."}},{"name":"jobId","in":"query","required":true,"description":"The Job Id returned part of the restore operation","schema":{"type":"string","description":"The Job Id returned part of the restore operation"}}],"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:azure-keyvault-administration/get-settings":{"get":{"operationId":"cloud_azure_keyvault_administration_get_settings","summary":"List account settings.","description":"GET /settings","tags":["cloud"],"parameters":[{"name":"vaultBaseUrl","in":"query","required":true,"description":"The base URL of the Key Vault instance (e.g. https://myvault.vault.azure.net/)","schema":{"type":"string","description":"The base URL of the Key Vault instance (e.g. https://myvault.vault.azure.net/)"}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"7.6","description":"The API version to use for this operation."}}],"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:azure-keyvault-administration/get-setting":{"get":{"operationId":"cloud_azure_keyvault_administration_get_setting","summary":"Get specified account setting object.","description":"GET /settings/{setting-name}","tags":["cloud"],"parameters":[{"name":"vaultBaseUrl","in":"query","required":true,"description":"The base URL of the Key Vault instance (e.g. https://myvault.vault.azure.net/)","schema":{"type":"string","description":"The base URL of the Key Vault instance (e.g. https://myvault.vault.azure.net/)"}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"7.6","description":"The API version to use for this operation."}},{"name":"setting-name","in":"query","required":true,"description":"The name of the account setting. Must be a valid settings option.","schema":{"type":"string","description":"The name of the account setting. Must be a valid settings option."}}],"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:azure-keyvault-administration/update-setting":{"post":{"operationId":"cloud_azure_keyvault_administration_update_setting","summary":"Updates key vault account setting, stores it, then returns the setting name and value to the client.","description":"PATCH /settings/{setting-name}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["vaultBaseUrl","setting-name","body"],"properties":{"vaultBaseUrl":{"type":"string","description":"The base URL of the Key Vault instance (e.g. https://myvault.vault.azure.net/)"},"api-version":{"type":"string","default":"7.6","description":"The API version to use for this operation."},"setting-name":{"type":"string","description":"The name of the account setting. Must be a valid settings option."},"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"}}},"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"}}}}}}}