This page contains the specification for V1 of the RedAPI, soon to be deprecated. See the RedAPI documentation for the latest OpenAPI specification and more detail about our API portal.
Companies
The company object represents either a customer or partner.
Get My Company Details
GET /companies
Gets the current user's root company (companiesGet)
Return type
Example data
Content-Type: application/json
{
"companyId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"companyName" : "companyName",
"isEnabled" : true,
"type" : "Partner",
"parentCompanyId" : "8e3bc432-e3e2-4209-9d3b-6cc85c9b312c"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Success Company
204 No Content
400 Bad Request ProblemDetails
401 Unauthorized ProblemDetails
404 Not Found ProblemDetails
500 Server Error ProblemDetails
Get Specific Company Details
GET /companies/{companyId}
Gets the specified company (companiesCompanyIdGet)
Path parameters
companyId (required)
Path Parameter — The company ID
Return type
Example data
Content-Type: application/json
{
"companyId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"companyName" : "companyName",
"isEnabled" : true,
"type" : "Partner",
"parentCompanyId" : "8e3bc432-e3e2-4209-9d3b-6cc85c9b312c"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Success Company
204 No Content
400 Bad Request ProblemDetails
401 Unauthorized ProblemDetails
404 Not Found ProblemDetails
500 Server Error ProblemDetails
List Customers
GET /companies/{companyId}/customers
Gets all customers for the specified company
Path parameters
companyId (required)
Path Parameter — The company ID
Query parameters
maxResults (optional)
Query Parameter — The maximum number of results to return format: int32
shouldReturnCount (optional)
Query Parameter — Indicate whether or not the response should include the total number of items that match the set of constraints
search (optional)
Query Parameter — Filter the results on company name
orderBy (optional)
Query Parameter — Order results by ascending or descending order
pageToken (optional)
Query Parameter — Token to get the next page
Return type
Example data
Content-Type: application/json
{
"nextPageToken" : "nextPageToken",
"totalCount" : 0,
"results" : [
{
"companyId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"companyName" : "companyName",
"isEnabled" : true,
"type" : "Partner",
"parentCompanyId" : "8e3bc432-e3e2-4209-9d3b-6cc85c9b312c"
},
{
"companyId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"companyName" : "companyName",
"isEnabled" : true,
"type" : "Partner",
"parentCompanyId" : "8e3bc432-e3e2-4209-9d3b-6cc85c9b312c"
}
]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Success CompanyPagedResult
204 No Content
400 Bad Request ProblemDetails
401 Unauthorized ProblemDetails
404 Not Found ProblemDetails
500 Server Error ProblemDetails
List Customers (Transitive)
GET /companies/{companyId}/customers/transitive
Gets a flat list of customers under the specified company
Path parameters
companyId (required)
Path Parameter — The company ID
Query parameters
maxResults (optional)
Query Parameter — The maximum number of results to return format: int32
shouldReturnCount (optional)
Query Parameter — Indicate whether or not the response should include the total number of items that match the set of constraints
search (optional)
Query Parameter — Filter the results on company name
orderBy (optional)
Query Parameter — Order results by ascending or descending order
pageToken (optional)
Query Parameter — Token to get the next page
Return type
Example data
Content-Type: application/json
{
"nextPageToken" : "nextPageToken",
"totalCount" : 0,
"results" : [
{
"companyId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"companyName" : "companyName",
"isEnabled" : true,
"type" : "Partner",
"parentCompanyId" : "8e3bc432-e3e2-4209-9d3b-6cc85c9b312c"
},
{
"companyId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"companyName" : "companyName",
"isEnabled" : true,
"type" : "Partner",
"parentCompanyId" : "8e3bc432-e3e2-4209-9d3b-6cc85c9b312c"
}
]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Success CompanyPagedResult
204 No Content
400 Bad Request ProblemDetails
401 Unauthorized ProblemDetails
404 Not Found ProblemDetails
500 Server Error ProblemDetails
Search Customers
GET /companies/search
Gets all companies matching the search criteria (companiesSearchGet)
Query parameters
search (required) Query Parameter — Filter the results on company name maxResults (optional) Query Parameter — The maximum number of results to return format: int32 shouldReturnCount (optional) Query Parameter — Indicate whether or not the response should include the total number of items that match the set of constraints pageToken (optional) Query Parameter — Token to get the next page
Return type
Example data
Content-Type: application/json
{
"nextPageToken" : "nextPageToken",
"totalCount" : 0,
"results" : [
{
"companyId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"companyName" : "companyName",
"isEnabled" : true,
"type" : "Partner",
"parentCompanyId" : "8e3bc432-e3e2-4209-9d3b-6cc85c9b312c"
},
{
"companyId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"companyName" : "companyName",
"isEnabled" : true,
"type" : "Partner",
"parentCompanyId" : "8e3bc432-e3e2-4209-9d3b-6cc85c9b312c"
}
]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Success CompanyPagedResult
204 No Content
400 Bad Request ProblemDetails
401 Unauthorized ProblemDetails
404 Not Found ProblemDetails
500 Server Error ProblemDetails
Create Customer
POST /companies/{companyId}/customers
Adds a customer to the specified company. This could be of type Partner or Customer.
Path parameters
companyId (required)
Path Parameter — The company ID format: uuid
Consumes
This API call consumes the following media types via the Content-Type request header:
application/jsontext/jsonapplication/*+json
Request body
body CreateCompanyRequest (optional) Body Parameter — Details of the customer to add
Return type
Example data
Content-Type: application/json
{
"companyId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"companyName" : "companyName",
"isEnabled" : true,
"type" : "Partner",
"parentCompanyId" : "8e3bc432-e3e2-4209-9d3b-6cc85c9b312c"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
201 Created Company
400 Bad Request ProblemDetails
401 Unauthorized ProblemDetails
404 Not Found ProblemDetails
500 Server Error ProblemDetails
Disable Customer
PATCH /companies/{companyId}/disable
Sets the specified company as disabled
Path parameters
companyId (required)
Path Parameter — The company ID format: uuid
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Success
400 Bad Request ProblemDetails
401 Unauthorized ProblemDetails
404 Not Found ProblemDetails
500 Server Error ProblemDetails
Enable Customer
PATCH /companies/{companyId}/enable
Sets the specified company as enabled
Path parameters
companyId (required)
Path Parameter — The company ID format: uuid
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Success
400 Bad Request ProblemDetails
401 Unauthorized ProblemDetails
404 Not Found ProblemDetails
500 Server Error ProblemDetails
Delete Company
DELETE /companies/{companyId}
Deletes the specified company
Path parameters
companyId (required)
Path Parameter — The company ID format: uuid
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Success
400 Bad Request ProblemDetails
401 Unauthorized ProblemDetails
404 Not Found ProblemDetails
500 Server Error ProblemDetails
Reassign Customer
PATCH /companies/{companyId}/customers/{customerId}/reassign
Reassigns a customer to the specified company
Path parameters
companyId (required)
Path Parameter — The company ID format: uuid customerId (required)
Path Parameter — The customer to reassign format: uuid
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Success
400 Bad Request ProblemDetails
401 Unauthorized ProblemDetails
404 Not Found ProblemDetails
500 Server Error ProblemDetails
Users
GET /users/list
Gets the users for the company (usersListGet)
Query parameters
companyId (required) Query Parameter — The company ID maxResults (optional) Query Parameter — The maximum number of results to return default: 0 format: int32 pageToken (optional) Query Parameter — Token to get the next page
Return type
Example data
Content-Type: application/json
{
"nextPageToken" : "nextPageToken",
"totalCount" : 0,
"results" : [
{
"userId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"name" : "name",
"email" : "email",
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"role" : "role",
"companyId" : "27fb7686-eabb-4343-bf5b-1053448d82e2",
"companyName" : "companyName",
"enabled" : true,
"verified" : true,
"sso" : "sso"
},
{
"userId" : "9563464d-7e56-48f8-be83-87c551fd8287",
"name" : "name",
"email" : "email",
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"role" : "role",
"companyId" : "27fb7686-eabb-4343-bf5b-1053448d82e2",
"companyName" : "companyName",
"enabled" : true,
"verified" : true,
"sso" : "sso"
}
]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Success UserPagedResult
204 No Content
400 Bad Request ProblemDetails
401 Unauthorized ProblemDetails
500 Server Error ProblemDetails
Products
List Available Products
GET /products
Gets the product catalog (getProducts)
Return type
array[ProductOverview]
Example data
Content-Type: application/json
[ {
"editions" : [ {
"hasTrial" : true,
"name" : "name",
"id" : 6
}, {
"hasTrial" : true,
"name" : "name",
"id" : 6
} ],
"children" : [ "children", "children" ],
"name" : "name",
"description" : "description",
"id" : 0,
"shortName" : "shortName"
}, {
"editions" : [ {
"hasTrial" : true,
"name" : "name",
"id" : 6
}, {
"hasTrial" : true,
"name" : "name",
"id" : 6
} ],
"children" : [ "children", "children" ],
"name" : "name",
"description" : "description",
"id" : 0,
"shortName" : "shortName"
} ]
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Success ProductOverview
204 No Content
400 Bad Request ProblemDetails
401 Unauthorized ProblemDetails
500 Server Error ProblemDetails
Get Specific Product Details
GET /products/{productId}
Gets a product from its ID (getProductFromId)
Path parameters
productId (required)
Path Parameter — The ID of the product
Return type
Example data
Content-Type: application/json
{
"editions" : [ {
"hasTrial" : true,
"name" : "name",
"id" : 6
}, {
"hasTrial" : true,
"name" : "name",
"id" : 6
} ],
"children" : [ "children", "children" ],
"name" : "name",
"description" : "description",
"id" : 0,
"shortName" : "shortName"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Success ProductOverview
400 Bad Request ProblemDetails
401 Unauthorized ProblemDetails
404 Not Found ProblemDetails
500 Server Error ProblemDetails
Subscriptions
List Company Subscriptions
GET /companies/{companyId}/subscriptions
Gets all product subscriptions for the specified company (companiesCompanyIdSubscriptionsGet)
Path parameters
companyId (required)
Path Parameter — The company ID format: uuid
Return type
array[ProductSubscription]
Example data
Content-Type: application/json
[ {
"productId" : 0,
"trialStatus" : "NotUsed",
"editionId" : 6,
"subscriptionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"isActive" : true
}, {
"productId" : 0,
"trialStatus" : "NotUsed",
"editionId" : 6,
"subscriptionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"isActive" : true
} ]
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Success ProductSubscription
204 No Content ProblemDetails
400 Bad Request ProblemDetails
401 Unauthorized ProblemDetails
404 Not Found ProblemDetails
422 Client Error ProblemDetails
500 Server Error ProblemDetails
Create Subscription
POST /companies/{companyId}/subscriptions
Adds new product subscriptions to the specified company (companiesCompanyIdSubscriptionsPost)
Path parameters
companyId (required) Path Parameter — The company ID format: uuid
Consumes
This API call consumes the following media types via the Content-Type request header:
application/jsontext/jsonapplication/*+json
Request body
body AddProductSubscriptionRequest (optional) Body Parameter —
Return type
Example data
Content-Type: application/json
{
"productId" : 0,
"trialStatus" : "NotUsed",
"editionId" : 6,
"subscriptionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"isActive" : true
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Success ProductSubscription
204 No Content ProblemDetails
400 Bad Request ProblemDetails
401 Unauthorized ProblemDetails
404 Not Found ProblemDetails
422 Client Error ProblemDetails
500 Server Error ProblemDetails
Delete Subscription
DELETE /companies/{companyId}/subscriptions/{subscriptionId}
Removes product subscriptions from the specified company (companiesCompanyIdSubscriptionsSubscriptionIdDelete)
Path parameters
companyId (required)
Path Parameter — The company ID format: uuid subscriptionId (required)
Path Parameter — The subscription ID format: uuid
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 The removal request has been successfully processed
202 The removal request has been queued
204 No Content ProblemDetails
400 Bad Request ProblemDetails
401 Unauthorized ProblemDetails
404 Not Found ProblemDetails
422 Client Error ProblemDetails
500 Server Error ProblemDetails
Create Trial Subscription
POST /companies/{companyId}/subscriptions/trial
Adds new product subscription trials to the specified company (companiesCompanyIdSubscriptionsTrialPost)
Path parameters
companyId (required)
Path Parameter — The company ID format: uuid
Consumes
This API call consumes the following media types via the Content-Type request header:
application/jsontext/jsonapplication/*+json
Request body
body AddProductSubscriptionRequest (optional) Body Parameter —
Return type
Example data
Content-Type: application/json
{
"productId" : 0,
"trialStatus" : "NotUsed",
"editionId" : 6,
"subscriptionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"isActive" : true
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Success ProductSubscription
204 No Content ProblemDetails
400 Bad Request ProblemDetails
401 Unauthorized ProblemDetails
404 Not Found ProblemDetails
422 Client Error ProblemDetails
500 Server Error ProblemDetails
Convert Trial Subscription
PATCH /companies/{companyId}/subscriptions/{subscriptionId}/trial/convert
Converts trial product subscriptions to full products for the specified company (companiesCompanyIdSubscriptionsSubscriptionIdTrialConvertPatch)
Path parameters
companyId (required)
Path Parameter — The company ID format: uuid subscriptionId (required)
Path Parameter — The subscription ID format: uuid
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Success
204 No Content ProblemDetails
400 Bad Request ProblemDetails
401 Unauthorized ProblemDetails
404 Not Found ProblemDetails
422 Client Error ProblemDetails
500 Server Error ProblemDetails
Consumption
Get Consumption Summary
GET /companies/{companyId}/consumption/summary
Gets the consumption summary for the specified company as well as the aggregated totals for all customers under the specified company (getConsumptionSummary)
Path parameters
companyId (required) Path Parameter — The company ID
Query parameters
date (optional) Query Parameter — Optional date for which to return the past consumption format: date-time shouldExcludeTrials(optional) Query Parameter — Optional filter to exclude the consumption for trial products. Default: false
Return type
Example data
Content-Type: application/json
{
"companySummary" : {
"totalDataProtectedInBytes" : 0,
"totalDataProtectedInBytesExternal" : 0,
"fupOverageInBytes" : 0,
"activeSeats" : 6,
"inactiveSeats" : 1,
"sharedSeats" : 1,
"activeWorkloads" : 5
},
"customerSummary" : {
"totalDataProtectedInBytes" : 0,
"totalDataProtectedInBytesExternal" : 0,
"fupOverageInBytes" : 0,
"activeSeats" : 25,
"inactiveSeats" : 3,
"sharedSeats" : 2,
"activeWorkloads" : 50
}
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Success Summary
204 No Content
400 Bad Request ProblemDetails
401 Unauthorized ProblemDetails
404 Not Found ProblemDetails
422 Client Error ProblemDetails
500 Server Error ProblemDetails
Get Company Consumption Details
GET /companies/{companyId}/consumption/company
Gets the consumption by product for the specified company (getProductConsumption)
Path parameters
companyId (required) Path Parameter — The company ID
Query parameters
date (optional) Query Parameter — Optional date for which to return the past consumption format: date-time shouldExcludeTrials(optional) Query Parameter — Optional filter to exclude the consumption for trial products. Default: false
Return type
array[ConsumptionWithProduct]
Example data
Content-Type: application/json
[
{
"totalDataProtectedInBytes" : 0,
"totalDataProtectedInBytesExternal" : 0,
"fupOverageInBytes" : 0,
"activeSeats" : 25,
"inactiveSeats" : 3,
"sharedSeats" : 2,
"activeWorkloads" : 50,
"productId" : 1,
"productName" : "productName",
"subscriptionId" : "subscriptionId",
"sku" : "sku",
"isTrial" : true
},
{
"totalDataProtectedInBytes" : 0,
"totalDataProtectedInBytesExternal" : 0,
"fupOverageInBytes" : 0,
"activeSeats" : 25,
"inactiveSeats" : 3,
"sharedSeats" : 2,
"activeWorkloads" : 50,
"productId" : 2,
"productName" : "productName",
"subscriptionId" : "subscriptionId",
"sku" : "sku",
"isTrial" : true
}
]
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Success ConsumptionWithProduct
204 No Content
400 Bad Request ProblemDetails
401 Unauthorized ProblemDetails
404 Not Found ProblemDetails
422 Client Error ProblemDetails
500 Server Error ProblemDetails
Get Customers Consumption Details (Direct)
GET /companies/{companyId}/consumption/customers/direct
Gets the aggregated consumption by product for all customers directly under the specified company (getCompanyConsumption)
Path parameters
companyId (required) Path Parameter — The company ID
Query parameters
maxResults (optional) Query Parameter — The maximum number of results to return format: int32 shouldReturnCount (optional) Query Parameter — Indicate whether or not the response should include the total number of items that match the set of constraints shouldExcludeTrials(optional) Query Parameter — Optional filter to exclude the consumption for trial products. Default: false date (optional) Query Parameter — Optional date for which to return the past consumption format: date-time pageToken (optional) Query Parameter — Token to get the next page
Return type
CompanyProductConsumptionPagedResult
Example data
Content-Type: application/json
{
"nextPageToken" : "nextPageToken",
"totalCount" : 0,
"results" : [
{
"companyId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"companyName" : "companyName",
"productConsumption" : [
{
"totalDataProtectedInBytes" : 0,
"totalDataProtectedInBytesExternal": 0,
"fupOverageInBytes": 0,
"activeSeats" : 25,
"inactiveSeats" : 3,
"sharedSeats" : 2,
"activeWorkloads" : 50,
"productId" : 1,
"productName" : "productName",
"subscriptionId" : "subscriptionId",
"sku": "sku",
"isTrial": true
},
{
"totalDataProtectedInBytes" : 0,
"totalDataProtectedInBytesExternal" : 0,
"fupOverageInBytes" : 0,
"activeSeats" : 25,
"inactiveSeats" : 3,
"sharedSeats" : 2,
"activeWorkloads" : 50,
"productId" : 2,
"productName" : "productName",
"subscriptionId" : "subscriptionId",
"sku" : "sku",
"isTrial" : true
}
]
},
{
"companyId" : "9d4205c0-9810-4e0f-aa19-2fae3179d769",
"companyName" : "companyName",
"productConsumption" : [
{
"totalDataProtectedInBytes" : 0,
"totalDataProtectedInBytesExternal" : 0,
"fupOverageInBytes" : 0,
"activeSeats" : 25,
"inactiveSeats" : 3,
"sharedSeats" : 2,
"activeWorkloads" : 50,
"productId" : 1,
"productName" : "productName",
"subscriptionId" : "subscriptionId",
"sku" : "sku",
"isTrial" : true
},
{
"totalDataProtectedInBytes" : 0,
"totalDataProtectedInBytesExternal" : 0,
"fupOverageInBytes": 0,
"activeSeats" : 25,
"inactiveSeats" : 3,
"sharedSeats" : 2,
"activeWorkloads" : 50,
"productId" : 2,
"productName" : "productName",
"subscriptionId" : "subscriptionId",
"sku" : "sku",
"isTrial" : true
}
]
}
]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Success CompanyProductConsumptionPagedResult
204 No Content
400 Bad Request ProblemDetails
401 Unauthorized ProblemDetails
404 Not Found ProblemDetails
422 Client Error ProblemDetails
500 Server Error ProblemDetails
Get Customers Consumption Details (Transitive)
GET /companies/{companyId}/consumption/customers/transitive
Gets a flat list of consumption by product for all customers associated with the specified company (getCompanyConsumptionTransitive)
Path parameters
companyId (required) Path Parameter — The company ID
Query parameters
maxResults (optional) Query Parameter — The maximum number of results to return format: int32 shouldReturnCount (optional) Query Parameter — Indicate whether or not the response should include the total number of items that match the set of constraints shouldExcludeTrials(optional) Query Parameter — Optional filter to exclude the consumption for trial products. Default: false date (optional) Query Parameter — Optional date for which to return the past consumption format: date-time pageToken (optional) Query Parameter — Token to get the next page
Return type
TransitiveConsumptionPagedResult
Example data
Content-Type: application/json
{
"nextPageToken" : "nextPageToken",
"totalCount" : 0,
"results" : [
{
"totalDataProtectedInBytes" : 0,
"totalDataProtectedInBytesExternal" : 0,
"fupOverageInBytes" : 0,
"activeSeats" : 25,
"inactiveSeats" : 3,
"sharedSeats" : 2,
"activeWorkloads" : 50,
"productId" : 1,
"productName" : "productName",
"subscriptionId" : "subscriptionId",
"sku": "sku",
"isTrial" : true,
"companyId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"companyName" : "string",
"parentCompanyId" : "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
{
"totalDataProtectedInBytes" : 0,
"totalDataProtectedInBytesExternal" : 0,
"fupOverageInBytes" : 0,
"activeSeats" : 25,
"inactiveSeats" : 3,
"sharedSeats" : 2,
"activeWorkloads" : 50,
"productId" : 2,
"productName" : "productName",
"subscriptionId" : "subscriptionId",
"sku": "sku",
"isTrial" : true,
"companyId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"companyName" : "string",
"parentCompanyId" : "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Success TransitiveConsumptionPagedResult
204 No Content
400 Bad Request ProblemDetails
401 Unauthorized ProblemDetails
404 Not Found ProblemDetails
422 Client Error ProblemDetails
500 Server Error ProblemDetails
Data Operations
Get Company Backup Statuses
GET /companies/{companyId}/backups/status
Gets the backup statuses by product for the specified company
Path parameters
companyId (required) Path Parameter — The company ID
Query parameters
productId (optional) Query Parameter — Optional product ID filter format: int32
Return type
CompanyOperationStatusByProduct
Example data
Content-Type: application/json
{
"companyId" : "ed14834c-bfa9-4b4e-8a9b-d1cd402836e2",
"companyName" : "Example Holdings",
"statuses" : [
{
"success" : 56,
"errors" : 0,
"warnings" : 0,
"failed" : 0,
"productName" : "O365",
"productId" : 4
},
{
"success" : 23,
"errors" : 0,
"warnings" : 2,
"failed" : 0,
"productName" : "Machines",
"productId" : 130
}
]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Success CompanyOperationStatusByProduct
204 No Content
400 Bad Request ProblemDetails
401 Unauthorized ProblemDetails
429 Too Many Requests ProblemDetails
500 Server Error ProblemDetails
Get Customers Backup Statuses
GET /companies/{companyId}/backups/status/customers
Gets the backup statuses by product for all customers under the specified company
Path parameters
companyId (required) Path Parameter — The company ID
Query parameters
maxResults (optional) Query Parameter — The maximum number of results to return format: int32 productId (optional) Query Parameter — Optional product ID filter format: int32 pageToken (optional) Query Parameter — Token to get the next page aggregate (optional) Query Parameter — Aggregate the status totals from downstream customers format: boolean
Return type
CompanyOperationStatusByProductPagedResult
Example data
Content-Type: application/json
{
"nextPageToken" : "eyJQYWdlIjoyLCJQYWdlU2l6ZSI6MzAsIlRvdGFsQ291bnQiOjM1fQ",
"totalCount" : 29,
"results" : [
{
"companyName" : "TestPartner",
"companyId" : "a36bad3c-e76f-4e40-b878-c17b7cd1c8dc",
"statuses" : [
{
"success" : 50,
"errors" : 0,
"warnings" : 6,
"failed" : 0,
"productName" : "O365",
"productId" : 4
},
{
"success" : 140,
"errors" : 0,
"warnings" : 0,
"failed" : 0,
"productName" : "Machines",
"productId" : 130
}
]
},
{
"companyName" : "TestPartner2",
"companyId" : "6efa730f-7c1b-4d37-8066-182191a5b77e",
"statuses" : [
{
"success" : 68,
"errors" : 3,
"warnings" : 10,
"failed" : 0,
"productName" : "O365",
"productId" : 4
}
]
}
]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Success CompanyOperationStatusByProductPagedResult
204 No Content
400 Bad Request ProblemDetails
401 Unauthorized ProblemDetails
429 Too Many Requests ProblemDetails
500 Server Error ProblemDetails
Get Accounts Backup Statuses
GET /companies/{companyId}/backups/status/accounts
Gets the backup statuses by account for the given company
Path parameters
companyId (required) Path Parameter — The company ID
Query parameters
maxResults (optional) Query Parameter — The maximum number of results to return format: int32 productId (optional) Query Parameter — Optional product ID filter format: int32 pageToken (optional) Query Parameter — Token to get the next page
Return type
OperationStatusByAccountPagedResult
Example data
Content-Type: application/json
{
"nextPageToken" : "eyJQYWdlIjoyLCJQYWdlU2l6ZSI6MzAsIlRvdGFsQ291bnQiOjM1fQ",
"totalCount" : 29,
"results" : [
{
"accountId": "5A82A6FE-95F2-481A-8D86-F0207BC42B0B",
"accountName": "alice@gmail.com",
"status": 2,
"productId": 105,
"companyId": "a36bad3c-e76f-4e40-b878-c17b7cd1c8dc",
"BackupSetGuid": "608CD098-BA3A-469D-923D-1A7E9F32634C",
"timestamp": "2023-08-05T02:40:28+00:00"
},
{
"accountId": "B56579EA-413A-4E5E-A54D-E89E14311FAB",
"accountName": "bob@gmail.com",
"status": 1,
"productId": 105,
"companyId": "a36bad3c-e76f-4e40-b878-c17b7cd1c8dc",
"BackupSetGuid": "608CD098-BA3A-469D-923D-1A7E9F32634C",
"timestamp": "2023-08-05T02:41:11+00:00"
},
{
"accountId": "482BFB99-0AE3-406D-AE58-CC18C91C88B8",
"accountName": "cody@redstor.com",
"status": 1,
"productId": 91,
"companyId": "a36bad3c-e76f-4e40-b878-c17b7cd1c8dc",
"groupId": "D26FF6BE-D5BA-452B-9646-97D680710659",
"timestamp": "2023-08-05T02:39:18+00:00"
}
]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Success OperationStatusByAccountPagedResult
204 No Content
400 Bad Request ProblemDetails
401 Unauthorized ProblemDetails
429 Too Many Requests ProblemDetails
500 Server Error ProblemDetails
Get Backup Status Summary
GET /companies/{companyId}/backups/status/summary
Gets the summarized backup statuses for the given company and the customers. Grouped by product
Path parameters
companyId (required) Path Parameter — The company ID
Query parameters
productId (optional) Query Parameter — Optional product ID filter format: int32
Return type
OperationStatusSummaryByProduct
Example data
Content-Type: application/json
{
"companySummary" : {
"companyId" : "ed14834c-bfa9-4b4e-8a9b-d1cd402836e2",
"companyName" : "Example Holdings",
"statuses" : [
{
"success" : 10,
"errors" : 0,
"warnings" : 0,
"failed" : 0,
"productName" : "O365",
"productId" : 4
},
{
"success" : 20,
"errors" : 1,
"warnings" : 0,
"failed" : 0,
"productName" : "Machines",
"productId" : 130
}
]
},
"customerSummary" : [
{
"success" : 399,
"errors" : 2,
"warnings" : 0,
"failed" : 0,
"productName" : "O365",
"productId" : 4
},
{
"success" : 150,
"errors" : 0,
"warnings" : 0,
"failed" : 0,
"productName" : "Machines",
"productId" : 130
}
]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Success OperationStatusSummaryByProduct
204 No Content
400 Bad Request ProblemDetails
401 Unauthorized ProblemDetails
429 Too Many Requests ProblemDetails
500 Server Error ProblemDetails
Get Company Restore Statuses
GET /companies/{companyId}/restores/status
Gets the restore statuses by product for the specified company
Path parameters
companyId (required) Path Parameter — The company ID
Query parameters
productId (optional) Query Parameter — Optional product ID filter format: int32
Return type
CompanyOperationStatusByProduct
Example data
Content-Type: application/json
{
"companyId" : "ed14834c-bfa9-4b4e-8a9b-d1cd402836e2",
"companyName" : "Example Holdings",
"statuses" : [
{
"success" : 56,
"errors" : 0,
"warnings" : 0,
"failed" : 0,
"productName" : "O365",
"productId" : 4
},
{
"success" : 23,
"errors" : 0,
"warnings" : 2,
"failed" : 0,
"productName" : "Machines",
"productId" : 130
}
]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Success CompanyOperationStatusByProduct
204 No Content
400 Bad Request ProblemDetails
401 Unauthorized ProblemDetails
429 Too Many Requests ProblemDetails
500 Server Error ProblemDetails
Get Customers Restore Statuses
GET /companies/{companyId}/restores/status/customers
Gets the restore statuses by product for all customers under the specified company
Path parameters
companyId (required) Path Parameter — The company ID
Query parameters
maxResults (optional) Query Parameter — The maximum number of results to return format: int32 productId (optional) Query Parameter — Optional product ID filter format: int32 pageToken (optional) Query Parameter — Token to get the next page aggregate (optional) Query Parameter — Aggregate the status totals from downstream customers format: boolean
Return type
CompanyOperationStatusByProductPagedResult
Example data
Content-Type: application/json
{
"nextPageToken" : "eyJQYWdlIjoyLCJQYWdlU2l6ZSI6MzAsIlRvdGFsQ291bnQiOjM1fQ",
"totalCount" : 29,
"results" : [
{
"companyName" : "TestPartner",
"companyId" : "a36bad3c-e76f-4e40-b878-c17b7cd1c8dc",
"statuses" : [
{
"success" : 50,
"errors" : 0,
"warnings" : 6,
"failed" : 0,
"productName" : "O365",
"productId" : 4
},
{
"success" : 140,
"errors" : 0,
"warnings" : 0,
"failed" : 0,
"productName" : "Machines",
"productId" : 130
}
]
},
{
"companyName" : "TestPartner2",
"companyId" : "6efa730f-7c1b-4d37-8066-182191a5b77e",
"statuses" : [
{
"success" : 68,
"errors" : 3,
"warnings" : 10,
"failed" : 0,
"productName" : "O365",
"productId" : 4
}
]
}
]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Success CompanyOperationStatusByProductPagedResult
204 No Content
400 Bad Request ProblemDetails
401 Unauthorized ProblemDetails
429 Too Many Requests ProblemDetails
500 Server Error ProblemDetails
Get Accounts Restore Statuses
GET /companies/{companyId}/restores/status/accounts
Gets the restore statuses by account for the given company
Path parameters
companyId (required) Path Parameter — The company ID
Query parameters
maxResults (optional) Query Parameter — The maximum number of results to return format: int32 productId (optional) Query Parameter — Optional product ID filter format: int32 pageToken (optional) Query Parameter — Token to get the next page
Return type
OperationStatusByAccountPagedResult
Example data
Content-Type: application/json
{
"nextPageToken" : "eyJQYWdlIjoyLCJQYWdlU2l6ZSI6MzAsIlRvdGFsQ291bnQiOjM1fQ",
"totalCount" : 29,
"results" : [
{
"accountId": "5A82A6FE-95F2-481A-8D86-F0207BC42B0B",
"accountName": "alice@gmail.com",
"status": 2,
"productId": 105,
"companyId": "a36bad3c-e76f-4e40-b878-c17b7cd1c8dc",
"BackupSetGuid": "608CD098-BA3A-469D-923D-1A7E9F32634C",
"timestamp": "2023-08-05T02:40:28+00:00"
},
{
"accountId": "B56579EA-413A-4E5E-A54D-E89E14311FAB",
"accountName": "bob@gmail.com",
"status": 1,
"productId": 105,
"companyId": "a36bad3c-e76f-4e40-b878-c17b7cd1c8dc",
"BackupSetGuid": "608CD098-BA3A-469D-923D-1A7E9F32634C",
"timestamp": "2023-08-05T02:41:11+00:00"
},
{
"accountId": "482BFB99-0AE3-406D-AE58-CC18C91C88B8",
"accountName": "cody@redstor.com",
"status": 1,
"productId": 91,
"companyId": "a36bad3c-e76f-4e40-b878-c17b7cd1c8dc",
"groupId": "D26FF6BE-D5BA-452B-9646-97D680710659",
"timestamp": "2023-08-05T02:39:18+00:00"
}
]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Success OperationStatusByAccountPagedResult
204 No Content
400 Bad Request ProblemDetails
401 Unauthorized ProblemDetails
429 Too Many Requests ProblemDetails
500 Server Error ProblemDetails
Get Restore Status Summary
GET /companies/{companyId}/restores/status/summary
Gets the summarized restore statuses for the given company and the customers. Grouped by product
Path parameters
companyId (required) Path Parameter — The company ID
Query parameters
productId (optional) Query Parameter — Optional product ID filter format: int32
Return type
OperationStatusSummaryByProduct
Example data
Content-Type: application/json
{
"companySummary" : {
"companyId" : "ed14834c-bfa9-4b4e-8a9b-d1cd402836e2",
"companyName" : "Example Holdings",
"statuses" : [
{
"success" : 10,
"errors" : 0,
"warnings" : 0,
"failed" : 0,
"productName" : "O365",
"productId" : 4
},
{
"success" : 20,
"errors" : 1,
"warnings" : 0,
"failed" : 0,
"productName" : "Machines",
"productId" : 130
}
]
},
"customerSummary" : [
{
"success" : 399,
"errors" : 2,
"warnings" : 0,
"failed" : 0,
"productName" : "O365",
"productId" : 4
},
{
"success" : 150,
"errors" : 0,
"warnings" : 0,
"failed" : 0,
"productName" : "Machines",
"productId" : 130
}
]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200 Success OperationStatusSummaryByProduct
204 No Content
400 Bad Request ProblemDetails
401 Unauthorized ProblemDetails
429 Too Many Requests ProblemDetails
500 Server Error ProblemDetails
Comments
0 comments
Article is closed for comments.