{ "opencollection": "1.0.0", "info": { "name": "Veeam Backup for AWS public API 1.0 Agents Credentials API", "version": "1.0-rev0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Credentials", "type": "folder" }, "items": [ { "info": { "name": "Get All Cloud Credentials", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/cloudCredentials", "headers": [ { "name": "x-api-version", "value": "" } ], "params": [ { "name": "skip", "value": "", "type": "query", "description": "Number of cloud credentials records to skip." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of cloud credentials records to return." }, { "name": "orderColumn", "value": "", "type": "query", "description": "Sorts cloud credentials by one of the cloud credentials parameters." }, { "name": "orderAsc", "value": "", "type": "query", "description": "Sorts cloud credentials in the ascending order by the `orderColumn` parameter." }, { "name": "nameFilter", "value": "", "type": "query", "description": "Filters cloud credentials by the `nameFilter` pattern. The pattern can match any cloud credentials parameter. To substitute one or more characters, use the asterisk (*) character at the beginning and/or at the end." }, { "name": "typeFilter", "value": "", "type": "query" } ] }, "docs": "The HTTP GET request to the `/api/v1/cloudCredentials` path allows you to get an array of credentials records used to connect to cloud services." }, { "info": { "name": "Add Cloud Credentials Record", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/cloudCredentials", "headers": [ { "name": "x-api-version", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "The HTTP POST request to the `/api/v1/cloudCredentials` path allows you to add a credentials record used to connect to cloud services." }, { "info": { "name": "Get Verification Code", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/cloudCredentials/appRegistration", "headers": [ { "name": "x-api-version", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "The HTTP POST request to the `/api/v1/cloudCredentials/appRegistration` path allows you to get a single-use verification code required to register a new Azure Active Directory application." }, { "info": { "name": "Register Azure AD Application", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/cloudCredentials/appRegistration/:verificationCode", "headers": [ { "name": "x-api-version", "value": "" } ], "params": [ { "name": "verificationCode", "value": "", "type": "path", "description": "Verification code. To obtain the code, use the [Get Verification Code](#tag/Credentials/operation/RequestAppRegistrationByDeviceCode) request." } ] }, "docs": "The HTTP POST request to the `/api/v1/cloudCredentials/appRegistration/{verificationCode}` path allows you to register a new Azure Active Directory application using the specified `verificationCode`." }, { "info": { "name": "Get Cloud Credentials Record", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/cloudCredentials/:id", "headers": [ { "name": "x-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the cloud credentials record." } ] }, "docs": "The HTTP GET request to the `/api/v1/cloudCredentials/{id}` path allows you to get a cloud credentials record that has the specified `id`." }, { "info": { "name": "Edit Cloud Credentials Record", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/cloudCredentials/:id", "headers": [ { "name": "x-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the cloud credentials record." } ], "body": { "type": "json", "data": "{}" } }, "docs": "The HTTP PUT request to the `/api/v1/cloudCredentials/{id}` path allows you to edit a cloud credentials record that has the specified `id`." }, { "info": { "name": "Remove Cloud Credentials Record", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/cloudCredentials/:id", "headers": [ { "name": "x-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the cloud credentials record." } ] }, "docs": "The HTTP DELETE request to the `/api/v1/cloudCredentials/{id}` path allows you to remove a cloud credentials record that has the specified `id`." }, { "info": { "name": "Change Certificate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/cloudCredentials/:id/changeCertificate", "headers": [ { "name": "x-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Azure compute account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "The HTTP POST request to the `/api/v1/cloudCredentials/{id}/changeCertificate` path allows you to change a certificate used for authentication in your Azure Active Directory application associated with an Azure compute account that has the specified `id`." }, { "info": { "name": "Change Secret Key", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/cloudCredentials/:id/changeSecretKey", "headers": [ { "name": "x-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the cloud credentials record." } ], "body": { "type": "json", "data": "{}" } }, "docs": "The HTTP POST request to the `/api/v1/cloudCredentials/{id}/changeSecretKey` path allows you to change a secret key of a cloud credentials record that has the specified `id`." }, { "info": { "name": "Get All Helper Appliances", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/cloudCredentials/:id/helperAppliances", "headers": [ { "name": "x-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Microsoft Azure compute account." } ] }, "docs": "The HTTP GET request to the `/api/v1/cloudCredentials/{id}/helperAppliances` path allows you to get an array of Lunux-based helper appliances of a Microsoft Azure compute account that has the specified `id`." }, { "info": { "name": "Add or Edit Helper Appliance", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/cloudCredentials/:id/helperAppliances", "headers": [ { "name": "x-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Microsoft Azure compute account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "The HTTP POST request to the `/api/v1/cloudCredentials/{id}/helperAppliances` path allows you to create a new Lunux-based helper appliance or edit settings of an existing one for a Microsoft Azure compute account that has the specified `id`." }, { "info": { "name": "Get Helper Appliance", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/cloudCredentials/:id/helperAppliances/:applianceId", "headers": [ { "name": "x-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Microsoft Azure compute account." }, { "name": "applianceId", "value": "", "type": "path", "description": "ID of the helper appliance." } ] }, "docs": "The HTTP GET request to the `/api/v1/cloudCredentials/{id}/helperAppliances/{applianceId}` path allows you to get a Lunux-based helper appliance with the `applianceId` of a Microsoft Azure compute account that has the specified `id`." }, { "info": { "name": "Remove Helper Appliance", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/cloudCredentials/:id/helperAppliances/:applianceId", "headers": [ { "name": "x-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Microsoft Azure compute account." }, { "name": "applianceId", "value": "", "type": "path", "description": "ID of the helper appliance." } ] }, "docs": "The HTTP DELETE request to the `/api/v1/cloudCredentials/{id}/helperAppliances/{applianceId}` path allows you to remove a Lunux-based helper appliance with the `applianceId` of a Microsoft Azure compute account that has the specified `id`." }, { "info": { "name": "Get All Credentials", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/credentials", "headers": [ { "name": "x-api-version", "value": "" } ], "params": [ { "name": "skip", "value": "", "type": "query", "description": "Number of credentials records to skip." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of credentials records to return." }, { "name": "orderColumn", "value": "", "type": "query", "description": "Sorts credentials by one of the credentials parameters." }, { "name": "orderAsc", "value": "", "type": "query", "description": "Sorts credentials in the ascending order by the `orderColumn` parameter." }, { "name": "nameFilter", "value": "", "type": "query", "description": "Filters credentials by the `nameFilter` pattern. The pattern can match any credentials parameter. To substitute one or more characters, use the asterisk (*) character at the beginning and/or at the end." } ] }, "docs": "The HTTP GET request to the `/api/v1/credentials` path allows you to get an array of credentials records that are added to the backup server." }, { "info": { "name": "Add Credentials Record", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/credentials", "headers": [ { "name": "x-api-version", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "The HTTP POST request to the `/api/v1/credentials` path allows you to add a credentials record." }, { "info": { "name": "Get Credentials Record", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/credentials/:id", "headers": [ { "name": "x-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the credentials record." } ] }, "docs": "The HTTP GET request to the `/api/v1/credentials/{id}` path allows you to get a credentials record that has the specified `id`." }, { "info": { "name": "Edit Credentials Record", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/credentials/:id", "headers": [ { "name": "x-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the credentials record." } ], "body": { "type": "json", "data": "{}" } }, "docs": "The HTTP PUT request to the `/api/v1/credentials/{id}` path allows you to edit a credentials record that has the specified `id`." }, { "info": { "name": "Remove Credentials Record", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/credentials/:id", "headers": [ { "name": "x-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the credentials record." } ] }, "docs": "The HTTP DELETE request to the `/api/v1/credentials/{id}` path allows you to remove a credentials record that has the specified `id`." }, { "info": { "name": "Change Password", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/credentials/:id/changepassword", "headers": [ { "name": "x-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the credentials record." } ], "body": { "type": "json", "data": "{}" } }, "docs": "The HTTP POST request to the `/api/v1/credentials/{id}/changepassword` path allows you to change a password of the credentials record that has the specified `id`." }, { "info": { "name": "Change Linux Private Key", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/credentials/:id/changeprivatekey", "headers": [ { "name": "x-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the credentials record." } ], "body": { "type": "json", "data": "{}" } }, "docs": "The HTTP POST request to the `/api/v1/credentials/{id}/changeprivatekey` path allows you to change a Linux private key of the credentials record that has the specified `id`." }, { "info": { "name": "Change Linux Root Password", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/credentials/:id/changerootpassword", "headers": [ { "name": "x-api-version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the credentials record." } ], "body": { "type": "json", "data": "{}" } }, "docs": "The HTTP POST request to the `/api/v1/credentials/{id}/changerootpassword` path allows you to change a Linux root password of the credentials record that has the specified `id`." } ] } ], "bundled": true }