Licenses

• Assignments
  • getGet assignment types
  • getGet license assignments to computers
  • postAdd license assignment to computer
  • putReplace license assignments to computers
  • delDelete license assignments to computers
  • getGet license assignment to computer
  • putReplace license assignment to computer
  • delDelete license assignment to computer
  • getGet license assignments to datacenters
  • postAdd license assignment to datacenter
  • putReplace license assignments to datacenters
  • delDelete license assignments to datacenters
  • getGet license assignment to datacenter
  • putReplace license assignment to datacenter
  • delDelete license assignment to datacenter
  • getGet license assignments summary
  • getGet license assignments to organizations
  • postAdd license assignment to organization
  • putReplace license assignments to organizations
  • delDelete license assignments to organizations
  • getGet license assignment to organization
  • putReplace license assignment to organization
  • delDelete license assignment to organization
  • getGet license assignment to site
  • postAdd license assignment to site
  • putReplace license assignment to site
  • delDelete license assignment to site
  • getGet license assignments to users
  • postAdd license assignment to user
  • putReplace license assignments to users
  • delDelete license assignments to users
  • getGet license assignment to user
  • delDelete license assignment to user
• Compliance
  • getGet compliance allocation summary
  • getGet compliance summary
  • getGet compliance usage summary
• Costs
  • getGet license costs
  • getGet a license costs for an organization
  • getGet a license costs summary
• Coverage
  • getGet licenses extended coverage types
  • getGet extended coverages
  • getGet extended coverage
• Entitlements
  • getGet license entitlements
  • getGet computers applications entitlements
  • getGet license entitlement states
  • getGet user license entitlements
• Licenses
  • getGet licenses
  • postAdd license
  • getGet license
  • putReplace license
  • delDelete license
  • postBulk update licenses
• Periods
  • getGet maintenance and support periods
  • getGet license's maintenance and support periods
  • postAdd maintenance and support period
  • putReplace maintenance and support periods
  • delDelete maintenance and support periods
  • putReplace maintenance and support period
  • delDelete maintenance and support period
• Policies
  • getGet license policy fields
  • getGet license policy field details
  • getGet license policies
  • getGet license policy details
• Tracking
  • getGet computer license tracking
  • getGet computer license tracking for a given application
  • getGet application license tracking for a computer
  • getGet application license tracking details
  • getGet user license tracking for application
  • getGet user license tracking for application
• Transfers
  • getGet application license transfers
  • getGet application license transfers for a computer
  • getGet custom value license transfers
  • getGet application license custom value transfers
  • getGet application license transfers
  • getGet users license transfer details
  • getGet user license transfer details
• Upgrades
  • getGet license upgrades
  • getGet the details of a license upgrade

API docs by Redocly

SAM: Licenses (1.7.0)

Download OpenAPI specification:Download

URL: https://www.flexera.com

Assignments

Get assignment types

Returns a collection of assignment types.

Authorizations:

BearerAuth

query Parameters

filter	string Example: filter=filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/assignment-types

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "assignmentType": 0,
    • "assignmentTypeId": "8e5d8f69-c818-4575-9a91-aebae9a9eacc",
    • "name": "Organization"

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get license assignments to computers

Returns a collection of a license's assignments to computers.

Authorizations:

BearerAuth

path Parameters

id required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.

query Parameters

filter	string Example: filter=filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments/computers

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "string",
    • "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "computerId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "quantity": 1,
    • "numberOfSupportedVirtualMachines": 1,
    • "hasVmUseRights": true,
    • "invalidAssignmentReasons": {

      • "0": "OverAssignment"

      },
    • "virtualMachines": {

      • "0": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

      }

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Add license assignment to computer

Creates a license assignment to computer.

Authorizations:

BearerAuth

path Parameters

id required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.

Request Body schema: application/json

computerId	string <guid> The unique ID of the computer.
quantity	integer <int32> The assigned quantity of licenses.
virtualMachines	Array of strings or null <guid> [ items <guid > ] The list of virtual machines.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments/computers

Request samples

• Payload

Content type

application/json

{

• "computerId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "quantity": 1,
• "virtualMachines": {

  • "0": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

  }

}

Response samples

• 201
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "id": "string"

}

Replace license assignments to computers

Replaces the given license’s assignments to computers.

Authorizations:

BearerAuth

path Parameters

id required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.

Request Body schema: application/json

Array

computerId	string <guid> The unique ID of the computer.
quantity	integer <int32> The assigned quantity of licenses.
virtualMachines	Array of strings or null <guid> [ items <guid > ] The list of virtual machines.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments/computers

Request samples

• Payload

Content type

application/json

[

• {

  • "computerId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
  • "quantity": 1,
  • "virtualMachines": {

    • "0": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

    }

  }

]

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "string",
    • "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "computerId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "quantity": 1,
    • "numberOfSupportedVirtualMachines": 1,
    • "hasVmUseRights": true,
    • "invalidAssignmentReasons": {

      • "0": "OverAssignment"

      },
    • "virtualMachines": {

      • "0": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

      }

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Delete license assignments to computers

Removes the given license’s assignments to computers.

Authorizations:

BearerAuth

path Parameters

id required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments/computers

Response samples

• 400
• 404
• 500

Content type

application/json

{

• "error": {

  • "code": 400,
  • "message": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request."

  }

}

Get license assignment to computer

Returns the details of the given license assignment to computer.

Authorizations:

BearerAuth

path Parameters

id required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.
assignmentId required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the assignment.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments/computers/{assignmentId}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "id": "string",
• "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "computerId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "quantity": 1,
• "numberOfSupportedVirtualMachines": 1,
• "hasVmUseRights": true,
• "invalidAssignmentReasons": {

  • "0": "OverAssignment"

  },
• "virtualMachines": {

  • "0": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

  }

}

Replace license assignment to computer

Replaces the given license assignment to computer.

Authorizations:

BearerAuth

path Parameters

id required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.
assignmentId required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the assignment.

Request Body schema: application/json

computerId	string <guid> The unique ID of the computer.
quantity	integer <int32> The assigned quantity of licenses.
virtualMachines	Array of strings or null <guid> [ items <guid > ] The list of virtual machines.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments/computers/{assignmentId}

Request samples

• Payload

Content type

application/json

{

• "computerId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "quantity": 1,
• "virtualMachines": {

  • "0": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

  }

}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "id": "string",
• "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "computerId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "quantity": 1,
• "numberOfSupportedVirtualMachines": 1,
• "hasVmUseRights": true,
• "invalidAssignmentReasons": {

  • "0": "OverAssignment"

  },
• "virtualMachines": {

  • "0": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

  }

}

Delete license assignment to computer

Removes the given license assignment to computer.

Authorizations:

BearerAuth

path Parameters

id required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.
assignmentId required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the assignment.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments/computers/{assignmentId}

Response samples

• 400
• 404
• 500

Content type

application/json

{

• "error": {

  • "code": 400,
  • "message": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request."

  }

}

Get license assignments to datacenters

Returns a collection of a license's assignments to datacenters.

Authorizations:

BearerAuth

path Parameters

id required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.

query Parameters

filter	string Example: filter=filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments/datacenters

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "string",
    • "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "datacenterId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "quantity": 1,
    • "numberOfSupportedVirtualMachines": 1,
    • "hasVmUseRights": true,
    • "invalidAssignmentReasons": {

      • "0": "OverAssignment"

      },
    • "virtualMachines": {

      • "0": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

      }

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Add license assignment to datacenter

Creates a license assignment to datacenter.

Authorizations:

BearerAuth

path Parameters

id required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.

Request Body schema: application/json

datacenterId	string <guid> The unique ID of the DCC.
quantity	integer <int32> The assigned quantity of licenses.
virtualMachines	Array of strings or null <guid> [ items <guid > ] The list of virtual machines.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments/datacenters

Request samples

• Payload

Content type

application/json

{

• "datacenterId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "quantity": 1,
• "virtualMachines": {

  • "0": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

  }

}

Response samples

• 201
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "id": "string"

}

Replace license assignments to datacenters

Replaces the given license’s assignments to datacenters.

Authorizations:

BearerAuth

path Parameters

id required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.

Request Body schema: application/json

Array

datacenterId	string <guid> The unique ID of the DCC.
quantity	integer <int32> The assigned quantity of licenses.
virtualMachines	Array of strings or null <guid> [ items <guid > ] The list of virtual machines.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments/datacenters

Request samples

• Payload

Content type

application/json

[

• {

  • "datacenterId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
  • "quantity": 1,
  • "virtualMachines": {

    • "0": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

    }

  }

]

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "string",
    • "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "datacenterId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "quantity": 1,
    • "numberOfSupportedVirtualMachines": 1,
    • "hasVmUseRights": true,
    • "invalidAssignmentReasons": {

      • "0": "OverAssignment"

      },
    • "virtualMachines": {

      • "0": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

      }

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Delete license assignments to datacenters

Removes the given license’s assignments to datacenters.

Authorizations:

BearerAuth

path Parameters

id required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments/datacenters

Response samples

• 400
• 404
• 500

Content type

application/json

{

• "error": {

  • "code": 400,
  • "message": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request."

  }

}

Get license assignment to datacenter

Returns the details of the given license assignment to datacenter.

Authorizations:

BearerAuth

path Parameters

id required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.
assignmentId required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the assignment.

query Parameters

filter	string Example: filter=filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments/datacenters/{assignmentId}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "id": "string",
• "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "datacenterId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "quantity": 1,
• "numberOfSupportedVirtualMachines": 1,
• "hasVmUseRights": true,
• "invalidAssignmentReasons": {

  • "0": "OverAssignment"

  },
• "virtualMachines": {

  • "0": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

  }

}

Replace license assignment to datacenter

Replaces the given license assignment to datacenter.

Authorizations:

BearerAuth

path Parameters

id required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.
assignmentId required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the assignment.

Request Body schema: application/json

datacenterId	string <guid> The unique ID of the DCC.
quantity	integer <int32> The assigned quantity of licenses.
virtualMachines	Array of strings or null <guid> [ items <guid > ] The list of virtual machines.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments/datacenters/{assignmentId}

Request samples

• Payload

Content type

application/json

{

• "datacenterId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "quantity": 1,
• "virtualMachines": {

  • "0": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

  }

}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "id": "string",
• "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "datacenterId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "quantity": 1,
• "numberOfSupportedVirtualMachines": 1,
• "hasVmUseRights": true,
• "invalidAssignmentReasons": {

  • "0": "OverAssignment"

  },
• "virtualMachines": {

  • "0": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

  }

}

Delete license assignment to datacenter

Removes the given license assignment to datacenter.

Authorizations:

BearerAuth

path Parameters

id required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.
assignmentId required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the assignment.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments/datacenters/{assignmentId}

Response samples

• 400
• 404
• 500

Content type

application/json

{

• "error": {

  • "code": 400,
  • "message": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request."

  }

}

Get license assignments summary

Returns the details of a license's assignments.

Authorizations:

BearerAuth

path Parameters

id required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments-summary

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "hasOrganizationAssignment": true,
• "hasComputerAssignment": true,
• "hasUserAssignment": true,
• "hasSiteAssignment": true

}

Get license assignments to organizations

Returns a collection of a license's assignments to organizations.

Authorizations:

BearerAuth

path Parameters

id required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.

query Parameters

filter	string Example: filter=filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments/organizations

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "string",
    • "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "quantity": 1,
    • "isAutoAllocated": true

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Add license assignment to organization

Creates a license assignment to organization.

Authorizations:

BearerAuth

path Parameters

id required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.

Request Body schema: application/json

organizationId	string <guid> The unique ID of the organization.
quantity	integer <int32> The assigned quantity of licenses.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments/organizations

Request samples

• Payload

Content type

application/json

{

• "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "quantity": 1

}

Response samples

• 201
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "id": "string"

}

Replace license assignments to organizations

Replaces the given license’s assignments to organizations.

Authorizations:

BearerAuth

path Parameters

id required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.

Request Body schema: application/json

Array

organizationId	string <guid> The unique ID of the organization.
quantity	integer <int32> The assigned quantity of licenses.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments/organizations

Request samples

• Payload

Content type

application/json

[

• {

  • "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
  • "quantity": 1

  }

]

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "string",
    • "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "quantity": 1,
    • "isAutoAllocated": true

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Delete license assignments to organizations

Removes the given license’s assignments to organizations.

Authorizations:

BearerAuth

path Parameters

id required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments/organizations

Response samples

• 400
• 404
• 500

Content type

application/json

{

• "error": {

  • "code": 400,
  • "message": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request."

  }

}

Get license assignment to organization

Returns the details of the given license assignment to organization.

Authorizations:

BearerAuth

path Parameters

id required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.
assignmentId required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the assignment.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments/organizations/{assignmentId}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "id": "string",
• "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "quantity": 1,
• "isAutoAllocated": true

}

Replace license assignment to organization

Replaces the given license assignment to organization.

Authorizations:

BearerAuth

path Parameters

id required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.
assignmentId required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the assignment.

Request Body schema: application/json

organizationId	string <guid> The unique ID of the organization.
quantity	integer <int32> The assigned quantity of licenses.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments/organizations/{assignmentId}

Request samples

• Payload

Content type

application/json

{

• "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "quantity": 1

}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "id": "string",
• "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "quantity": 1,
• "isAutoAllocated": true

}

Delete license assignment to organization

Removes the given license assignment to organization.

Authorizations:

BearerAuth

path Parameters

id required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.
assignmentId required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the assignment.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments/organizations/{assignmentId}

Response samples

• 400
• 404
• 500

Content type

application/json

{

• "error": {

  • "code": 400,
  • "message": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request."

  }

}

Get license assignment to site

Returns the details of the given license’s assignment to site.

Authorizations:

BearerAuth

path Parameters

id required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments/site

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "id": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "quantity": 1

}

Add license assignment to site

Creates a license assignment to site.

Authorizations:

BearerAuth

path Parameters

id required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.

Request Body schema: application/json

organizationId

string <guid> The unique ID of the organization.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments/site

Request samples

• Payload

Content type

application/json

{

• "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

}

Response samples

• 201
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "id": "string"

}

Replace license assignment to site

Replaces the given license assignment to site.

Authorizations:

BearerAuth

path Parameters

id required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.
assignmentId required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the assignment.

Request Body schema: application/json

organizationId

string <guid> The unique ID of the organization.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments/site/{assignmentId}

Request samples

• Payload

Content type

application/json

{

• "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "id": "string"

}

Delete license assignment to site

Removes the given license assignment to site.

Authorizations:

BearerAuth

path Parameters

id required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.
assignmentId required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the assignment.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments/site/{assignmentId}

Response samples

• 400
• 404
• 500

Content type

application/json

{

• "error": {

  • "code": 400,
  • "message": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request."

  }

}

Get license assignments to users

Returns a collection of a license's assignments to users.

Authorizations:

BearerAuth

path Parameters

id required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.

query Parameters

filter	string Example: filter=filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments/users

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "string",
    • "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "userId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "quantity": 1,
    • "invalidAssignmentReasons": {

      • "0": "OverAssignment"

      }

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Add license assignment to user

Creates a license assignment to user.

Authorizations:

BearerAuth

path Parameters

id required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.

Request Body schema: application/json

userId

string <guid> The unique ID of the user.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments/users

Request samples

• Payload

Content type

application/json

{

• "userId": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

}

Response samples

• 201
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "id": "string"

}

Replace license assignments to users

Replaces the given license’s assignments to users.

Authorizations:

BearerAuth

path Parameters

id required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.

Request Body schema: application/json

Array

userId

string <guid> The unique ID of the user.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments/users

Request samples

• Payload

Content type

application/json

[

• {

  • "userId": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

  }

]

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "string",
    • "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "userId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "quantity": 1,
    • "invalidAssignmentReasons": {

      • "0": "OverAssignment"

      }

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Delete license assignments to users

Removes the given license’s assignment to users.

Authorizations:

BearerAuth

path Parameters

id required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments/users

Response samples

• 400
• 404
• 500

Content type

application/json

{

• "error": {

  • "code": 400,
  • "message": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request."

  }

}

Get license assignment to user

Returns the details of the given license assignment to user.

Authorizations:

BearerAuth

path Parameters

id required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.
assignmentId required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the assignment.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments/users/{assignmentId}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "id": "string",
• "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "userId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "quantity": 1,
• "invalidAssignmentReasons": {

  • "0": "OverAssignment"

  }

}

Delete license assignment to user

Removes the given license assignment to user.

Authorizations:

BearerAuth

path Parameters

id required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.
assignmentId required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the assignment.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/assignments/users/{assignmentId}

Response samples

• 400
• 404
• 500

Content type

application/json

{

• "error": {

  • "code": 400,
  • "message": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request."

  }

}

Compliance

Get compliance allocation summary

Returns a collection of compliance allocations for an application.

Authorizations:

BearerAuth

path Parameters

applicationId required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the application.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/compliance/summary/{applicationId}/allocation

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "metricId": "5891a1d8-7fb0-45bd-b1f6-01c943f9c572",
    • "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "requirement": 1,
    • "coverage": 1,
    • "compliance": 1

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get compliance summary

Returns a collection of application compliance summary.

Authorizations:

BearerAuth

path Parameters

applicationId required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the application.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/compliance/summary/{applicationId}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "metricId": "5891a1d8-7fb0-45bd-b1f6-01c943f9c572",
    • "availableLicenses": 1,
    • "compliance": 1,
    • "licensesPurchased": 1,
    • "incompleteLicenses": 1,
    • "expiredSubscriptionLicenses": 1,
    • "invalidAssignments": 1,
    • "unassigned": 1,
    • "assignedNamedUsers": 1,
    • "siteLicenses": 1,
    • "downgradesGiven": 1,
    • "downgradesReceived": 1,
    • "upgradesGiven": 1,
    • "upgradesReceived": 1,
    • "crossPlatformGiven": 1,
    • "crossPlatformReceived": 1,
    • "crossEditionGiven": 1,
    • "crossEditionReceived": 1,
    • "initialRequirement": 1,
    • "includedInBundle": 1,
    • "outsideMetricPeriod": 1,
    • "secondaryUseRightsDesktopLaptop": 1,
    • "secondaryUseRightsDevice": 1,
    • "extendedCoverageForDcc": 1,
    • "extendedCoverageForHosts": 1,
    • "multipleVersionEdition": 1,
    • "virtualDesktopInfrastructure": 1,
    • "minimumRequirement": 1,
    • "coreFactor": 1,
    • "physicalHost": 1,
    • "licenseRequirement": 1,
    • "computerAppExclusions": 1,
    • "windowsServer": 1,
    • "sqlServer": 1,
    • "otherMetricCoverage": 1,
    • "siteCoverage": 1,
    • "vmCoverage": 1,
    • "licenseStacking": 1,
    • "namedUserCoverage": 1,
    • "licensingOtherMetrics": 1,
    • "virtualDesktopAccess": 1,
    • "totalCoverage": 1

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get compliance usage summary

Returns a collection of application compliance usage summary.

Authorizations:

BearerAuth

path Parameters

applicationId required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the application.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/compliance/summary/{applicationId}/usage

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "metricId": "5891a1d8-7fb0-45bd-b1f6-01c943f9c572",
    • "licenseMetricId": "5891a1d8-7fb0-45bd-b1f6-01c943f9c572",
    • "otherMetricCoverage": 1,
    • "mainCoverage": 1,
    • "isPartial": true,
    • "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Costs

Get license costs

Returns a collection of license costs.

Authorizations:

BearerAuth

path Parameters

id required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.

query Parameters

filter	string Example: filter=filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/costs

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "licenseQuantity": 1,
    • "licensePurchaseCost": 1000,
    • "currentMaintenanceCost": 1000,
    • "accumulatedMaintenanceCost": 1000,
    • "currentSupportCost": 1000,
    • "accumulatedSupportCost": 1000,
    • "totalCost": 1000,
    • "currency": "USD"

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get a license costs for an organization

Returns the details of a license costs for an organization.

Authorizations:

BearerAuth

path Parameters

id required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.
organizationId required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the organization.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/costs/{organizationId}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "licenseQuantity": 1,
• "licensePurchaseCost": 1000,
• "currentMaintenanceCost": 1000,
• "accumulatedMaintenanceCost": 1000,
• "currentSupportCost": 1000,
• "accumulatedSupportCost": 1000,
• "totalCost": 1000,
• "currency": "USD"

}

Get a license costs summary

Returns the details of a license costs.

Authorizations:

BearerAuth

path Parameters

id required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/costs-summary

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "quantity": 1,
• "purchaseCost": 1000,
• "currentMaintenanceCost": 1000,
• "accumulatedMaintenanceCost": 1000,
• "currentSupportCost": 1000,
• "accumulatedSupportCost": 1000,
• "totalCost": 1000,
• "averageCostPerLicensePurchase": 100,
• "currency": "USD"

}

Coverage

Get licenses extended coverage types

Returns a collection of extended coverage types.

Authorizations:

BearerAuth

query Parameters

filter	string Example: filter=filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses-extended-coverage-types

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "name": "Passive"

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get extended coverages

Returns a collection of extended coverages.

Authorizations:

BearerAuth

query Parameters

filter	string Example: filter=filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/extended-coverage

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "parentComputerId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "isParentComputerDatacenter": true,
    • "extendedComputerId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "coveredApplicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "reason": "Disaster",
    • "reasonDescription": "The recovery reason description"

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get extended coverage

Returns the details of an extended coverage.

Authorizations:

BearerAuth

path Parameters

coverageId required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the coverage.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/extended-coverage/{coverageId}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "id": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "parentComputerId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "isParentComputerDatacenter": true,
• "extendedComputerId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "coveredApplicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "reason": "Disaster",
• "reasonDescription": "The recovery reason description"

}

Entitlements

Get license entitlements

Returns a collection of license entitlements.

Authorizations:

BearerAuth

query Parameters

filter	string Example: filter=filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses-entitlements

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "metricId": "5891a1d8-7fb0-45bd-b1f6-01c943f9c572",
    • "assignmentType": "Organization",
    • "quantity": 1

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get computers applications entitlements

Returns a collection of computers and applications entitlements.

Authorizations:

BearerAuth

query Parameters

filter	string Example: filter=filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/entitlements/computers

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "computerId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "metricId": "5891a1d8-7fb0-45bd-b1f6-01c943f9c572",
    • "entitlementStateId": "6fb32edf-1d45-44e3-a55d-6df6068c0c08"

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get license entitlement states

Returns a collection of entitlements states.

Authorizations:

BearerAuth

query Parameters

page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/entitlements/entitlement-states

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "name": "Partially covered",
    • "description": "The virtual machine is licensed by the host it is running on."

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get user license entitlements

Returns a collection of user entitlements.

Authorizations:

BearerAuth

query Parameters

filter	string Example: filter=filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/entitlements/users

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "userId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "metricId": "5891a1d8-7fb0-45bd-b1f6-01c943f9c572",
    • "entitlementStateId": "6fb32edf-1d45-44e3-a55d-6df6068c0c08"

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Licenses

Get licenses

Returns a collection of licenses.

Authorizations:

BearerAuth

query Parameters

filter	string Example: filter=filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "contractId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "agreementId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "metricId": "5891a1d8-7fb0-45bd-b1f6-01c943f9c572",
    • "assignmentTypeId": "8e5d8f69-c818-4575-9a91-aebae9a9eacc",
    • "purchaseDate": "2024-01-01T00:00:00Z",
    • "purchaseValue": 1000,
    • "purchaseCurrency": "USD",
    • "quantity": 1,
    • "initialQuantity": 1,
    • "mediaStorage": "path/to/file",
    • "licenseProofLocation": "path/to/licenseproof",
    • "invoiceReference": "INV12345",
    • "vendor": "Microsoft",
    • "externalId": "EXT12345",
    • "productDescription": "MSDN",
    • "isSubscription": true,
    • "isCrossEdition": true,
    • "isCrossPlatform": true,
    • "isUpgrade": true,
    • "isDowngrade": true,
    • "isIncomplete": true,
    • "incompleteReasons": {

      • "0": "MissingApplication"

      },
    • "updatedDate": "2024-01-01T00:00:00Z",
    • "createdDate": "2024-01-01T00:00:00Z",
    • "subscriptionValidFrom": "2024-01-01T00:00:00Z",
    • "subscriptionValidTo": "2025-01-01T00:00:00Z",
    • "activeMaintenanceCost": 1000,
    • "totalMaintenanceCost": 1000,
    • "activeSupportCost": 1000,
    • "totalSupportCost": 1000,
    • "totalLicenseCost": 1000,
    • "upgradedLicenseCount": 1000,
    • "autoAllocateOnce": true,
    • "isAutoAllocated": true,
    • "maintenanceAccordingToAgreement": true,
    • "skuId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "upgrades": [

      • {

        • "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
        • "quantity": 1,
        • "upgradedLicenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
        • "upgradedQuantity": 1

        }

      ],
    • "status": "Active",
    • "archivedDate": "2024-01-01T00:00:00Z"

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Add license

Creates a license.

Authorizations:

BearerAuth

Request Body schema: application/json

agreementId	string or null <guid> The unique ID of the agreement.
applicationId	string or null <guid> The unique ID of the application.
autoAllocateOnce	boolean or null true if has auto allocate once selected; otherwise, false.
assignmentTypeId	string or null <guid> The unique ID of the assignment type.
externalId	string or null The external ID.
invoiceReference	string or null The invoice reference.
isAutoAllocated	boolean or null true if has auto allocate selected; otherwise, false.
isCrossEdition	boolean true if is cross-edition; otherwise, false.
isCrossPlatform	boolean true if is cross-platform; otherwise, false.
isDowngrade	boolean true if is downgrade; otherwise, false.
isSubscription	boolean or null true if is subscription; otherwise, false.
isUpgrade	boolean true if is upgrade; otherwise, false.
quantity	integer or null <int32> The quantity.
licenseKeys	string or null The license keys.
licenseProofLocation	string or null The license proof location.
maintenanceAccordingToAgreement	boolean true if has maintenance according to agreement selected; otherwise, false.
mediaStorage	string or null The media storage.
metricId	string or null <guid> The unique ID of the metric.
notes	string or null The notes.
organizationId	string <guid> The unique ID of the organization.
productDescription	string or null The product description.
purchaseDate	string <date-time> The purchase date.
purchaseValue	number or null <decimal> The purchase value.
purchaseCurrency	string or null The purchase currency.
sku	string or null The stock keeping unit.
subscriptionValidFrom	string or null <date-time> The subscription valid from date.
subscriptionValidTo	string or null <date-time> The subscription valid to date.
vendor	string or null The vendor.
	Array of objects or null (LicenseUpgradeRequest) The license upgrades.
Array upgradedLicenseId string <guid> The unique ID of the base license. upgradedQuantity integer <int32> The quantity sent from the base license. quantity integer <int32> The quantity received on the upgraded license.
	Array of objects or null (MaintenancePeriodRequest) The maintenance and support periods.
Array agreementPeriodId string or null <guid> The unique ID of the agreement period. validFrom string or null <date-time> The valid form date. validTo string or null <date-time> The valid to date. hasUpgradeRights boolean true if has upgrade rights; otherwise, false. invoiceReference string or null The invoice reference. notes string or null The notes. maintenanceCost number or null <decimal> The maintenance cost. supportCost number or null <decimal> The support cost.
	Array of objects or null (ComputerAssignmentRequest) The computer assignments.
Array computerId string <guid> The unique ID of the computer. quantity integer <int32> The assigned quantity of licenses. virtualMachines Array of strings or null <guid> [ items <guid > ] The list of virtual machines.
	Array of objects or null (DatacenterAssignmentRequest) The datacenter assignments.
Array datacenterId string <guid> The unique ID of the DCC. quantity integer <int32> The assigned quantity of licenses. virtualMachines Array of strings or null <guid> [ items <guid > ] The list of virtual machines.
	Array of objects or null (OrganizationAssignmentRequest) The organization assignments.
Array organizationId string <guid> The unique ID of the organization. quantity integer <int32> The assigned quantity of licenses.
	Array of objects or null (UserAssignmentRequest) The user assignments.
Array userId string <guid> The unique ID of the user.
	(SiteAssignmentRequest (object or null)) The site assignment.
One of organizationId string <guid> The unique ID of the organization.
hasVmUseRights	boolean or null true if has VM use rights; otherwise, false.
numberOfSupportedVirtualMachines	integer or null <int32> The number of VM supported by license.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses

Request samples

• Payload

Content type

application/json

{

• "agreementId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "autoAllocateOnce": true,
• "assignmentTypeId": "8e5d8f69-c818-4575-9a91-aebae9a9eacc",
• "externalId": "EXT12345",
• "invoiceReference": "INV12345",
• "isAutoAllocated": true,
• "isCrossEdition": true,
• "isCrossPlatform": true,
• "isDowngrade": true,
• "isSubscription": true,
• "isUpgrade": true,
• "quantity": 1,
• "licenseKeys": "69658998-12-12031517-23",
• "licenseProofLocation": "path/to/licenseproof",
• "maintenanceAccordingToAgreement": true,
• "mediaStorage": "path/to/file",
• "metricId": "5891a1d8-7fb0-45bd-b1f6-01c943f9c572",
• "notes": "Notes",
• "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "productDescription": "MSDN",
• "purchaseDate": "2024-01-01T00:00:00Z",
• "purchaseValue": 1000,
• "purchaseCurrency": "USD",
• "sku": "ABC-12345-S-BL",
• "subscriptionValidFrom": "2024-01-01T00:00:00Z",
• "subscriptionValidTo": "2025-01-01T00:00:00Z",
• "vendor": "Microsoft",
• "upgrades": [

  • {

    • "upgradedLicenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "upgradedQuantity": 1,
    • "quantity": 1

    }

  ],
• "maintenancePeriods": [

  • {

    • "agreementPeriodId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "validFrom": "2024-01-01T00:00:00Z",
    • "validTo": "2025-01-01T00:00:00Z",
    • "hasUpgradeRights": true,
    • "invoiceReference": "INV12345",
    • "notes": "Notes",
    • "maintenanceCost": 1000,
    • "supportCost": 1000

    }

  ],
• "computerAssignments": [

  • {

    • "computerId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "quantity": 1,
    • "virtualMachines": {

      • "0": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

      }

    }

  ],
• "datacenterAssignments": [

  • {

    • "datacenterId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "quantity": 1,
    • "virtualMachines": {

      • "0": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

      }

    }

  ],
• "organizationAssignments": [

  • {

    • "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "quantity": 1

    }

  ],
• "userAssignments": [

  • {

    • "userId": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

    }

  ],
• "siteAssignment": {

  • "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

  },
• "hasVmUseRights": true,
• "numberOfSupportedVirtualMachines": 3

}

Response samples

• 201
• 400
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "id": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "assignmentTypeId": "8e5d8f69-c818-4575-9a91-aebae9a9eacc",
• "autoAllocateOnce": true,
• "isAutoAllocated": true,
• "metricId": "5891a1d8-7fb0-45bd-b1f6-01c943f9c572",
• "purchaseDate": "2024-01-01T00:00:00Z",
• "purchaseValue": 1000,
• "purchaseCurrency": "USD",
• "quantity": 1,
• "licenseKeys": "69658998-12-12031517-23",
• "mediaStorage": "path/to/file",
• "licenseProofLocation": "path/to/licenseproof",
• "invoiceReference": "INV12345",
• "vendor": "Microsoft",
• "notes": "Notes",
• "externalId": "EXT12345",
• "sku": "ABC-12345-S-BL",
• "productDescription": "MSDN",
• "isSubscription": true,
• "isCrossEdition": true,
• "isCrossPlatform": true,
• "isUpgrade": true,
• "isDowngrade": true,
• "isIncomplete": true,
• "incompleteReasons": {

  • "0": "MissingApplication"

  },
• "contractId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "agreementId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "updatedDate": "2024-01-01T00:00:00Z",
• "createdDate": "2024-01-01T00:00:00Z",
• "subscriptionValidFrom": "2024-01-01T00:00:00Z",
• "subscriptionValidTo": "2025-01-01T00:00:00Z",
• "upgradedLicenseCount": 1,
• "maintenanceAccordingToAgreement": true,
• "skuId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "hasVmUseRights": true,
• "numberOfSupportedVirtualMachines": 100,
• "status": "Active",
• "archivedDate": "2024-01-01T00:00:00Z"

}

Get license

Returns the details of the given license.

Authorizations:

BearerAuth

path Parameters

id required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "id": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "assignmentTypeId": "8e5d8f69-c818-4575-9a91-aebae9a9eacc",
• "autoAllocateOnce": true,
• "isAutoAllocated": true,
• "metricId": "5891a1d8-7fb0-45bd-b1f6-01c943f9c572",
• "purchaseDate": "2024-01-01T00:00:00Z",
• "purchaseValue": 1000,
• "purchaseCurrency": "USD",
• "quantity": 1,
• "licenseKeys": "69658998-12-12031517-23",
• "mediaStorage": "path/to/file",
• "licenseProofLocation": "path/to/licenseproof",
• "invoiceReference": "INV12345",
• "vendor": "Microsoft",
• "notes": "Notes",
• "externalId": "EXT12345",
• "sku": "ABC-12345-S-BL",
• "productDescription": "MSDN",
• "isSubscription": true,
• "isCrossEdition": true,
• "isCrossPlatform": true,
• "isUpgrade": true,
• "isDowngrade": true,
• "isIncomplete": true,
• "incompleteReasons": {

  • "0": "MissingApplication"

  },
• "contractId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "agreementId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "updatedDate": "2024-01-01T00:00:00Z",
• "createdDate": "2024-01-01T00:00:00Z",
• "subscriptionValidFrom": "2024-01-01T00:00:00Z",
• "subscriptionValidTo": "2025-01-01T00:00:00Z",
• "upgradedLicenseCount": 1,
• "maintenanceAccordingToAgreement": true,
• "skuId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "hasVmUseRights": true,
• "numberOfSupportedVirtualMachines": 100,
• "status": "Active",
• "archivedDate": "2024-01-01T00:00:00Z"

}

Replace license

Replaces the given license.

Authorizations:

BearerAuth

path Parameters

id required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.

Request Body schema: application/json

agreementId	string or null <guid> The unique ID of the agreement.
applicationId	string or null <guid> The unique ID of the application.
autoAllocateOnce	boolean or null true if has auto allocate once selected; otherwise, false.
assignmentTypeId	string or null <guid> The unique ID of the assignment type.
externalId	string or null The external ID.
invoiceReference	string or null The invoice reference.
isAutoAllocated	boolean or null true if has auto allocate selected; otherwise, false.
isCrossEdition	boolean true if is cross-edition; otherwise, false.
isCrossPlatform	boolean true if is cross-platform; otherwise, false.
isDowngrade	boolean true if is downgrade; otherwise, false.
isSubscription	boolean or null true if is subscription; otherwise, false.
isUpgrade	boolean true if is upgrade; otherwise, false.
quantity	integer or null <int32> The quantity.
licenseKeys	string or null The license keys.
licenseProofLocation	string or null The license proof location.
maintenanceAccordingToAgreement	boolean true if has maintenance according to agreement selected; otherwise, false.
mediaStorage	string or null The media storage.
metricId	string or null <guid> The unique ID of the metric.
notes	string or null The notes.
organizationId	string <guid> The unique ID of the organization.
productDescription	string or null The product description.
purchaseDate	string <date-time> The purchase date.
purchaseValue	number or null <decimal> The purchase value.
purchaseCurrency	string or null The purchase currency.
sku	string or null The stock keeping unit.
subscriptionValidFrom	string or null <date-time> The subscription valid from date.
subscriptionValidTo	string or null <date-time> The subscription valid to date.
vendor	string or null The vendor.
	Array of objects or null (LicenseUpgradeRequest) The license upgrades.
Array upgradedLicenseId string <guid> The unique ID of the base license. upgradedQuantity integer <int32> The quantity sent from the base license. quantity integer <int32> The quantity received on the upgraded license.
	Array of objects or null (MaintenancePeriodRequest) The maintenance and support periods.
Array agreementPeriodId string or null <guid> The unique ID of the agreement period. validFrom string or null <date-time> The valid form date. validTo string or null <date-time> The valid to date. hasUpgradeRights boolean true if has upgrade rights; otherwise, false. invoiceReference string or null The invoice reference. notes string or null The notes. maintenanceCost number or null <decimal> The maintenance cost. supportCost number or null <decimal> The support cost.
	Array of objects or null (ComputerAssignmentRequest) The computer assignments.
Array computerId string <guid> The unique ID of the computer. quantity integer <int32> The assigned quantity of licenses. virtualMachines Array of strings or null <guid> [ items <guid > ] The list of virtual machines.
	Array of objects or null (DatacenterAssignmentRequest) The datacenter assignments.
Array datacenterId string <guid> The unique ID of the DCC. quantity integer <int32> The assigned quantity of licenses. virtualMachines Array of strings or null <guid> [ items <guid > ] The list of virtual machines.
	Array of objects or null (OrganizationAssignmentRequest) The organization assignments.
Array organizationId string <guid> The unique ID of the organization. quantity integer <int32> The assigned quantity of licenses.
	Array of objects or null (UserAssignmentRequest) The user assignments.
Array userId string <guid> The unique ID of the user.
	(SiteAssignmentRequest (object or null)) The site assignment.
One of organizationId string <guid> The unique ID of the organization.
hasVmUseRights	boolean or null true if has VM use rights; otherwise, false.
numberOfSupportedVirtualMachines	integer or null <int32> The number of VM supported by license.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}

Request samples

• Payload

Content type

application/json

{

• "agreementId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "autoAllocateOnce": true,
• "assignmentTypeId": "8e5d8f69-c818-4575-9a91-aebae9a9eacc",
• "externalId": "EXT12345",
• "invoiceReference": "INV12345",
• "isAutoAllocated": true,
• "isCrossEdition": true,
• "isCrossPlatform": true,
• "isDowngrade": true,
• "isSubscription": true,
• "isUpgrade": true,
• "quantity": 1,
• "licenseKeys": "69658998-12-12031517-23",
• "licenseProofLocation": "path/to/licenseproof",
• "maintenanceAccordingToAgreement": true,
• "mediaStorage": "path/to/file",
• "metricId": "5891a1d8-7fb0-45bd-b1f6-01c943f9c572",
• "notes": "Notes",
• "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "productDescription": "MSDN",
• "purchaseDate": "2024-01-01T00:00:00Z",
• "purchaseValue": 1000,
• "purchaseCurrency": "USD",
• "sku": "ABC-12345-S-BL",
• "subscriptionValidFrom": "2024-01-01T00:00:00Z",
• "subscriptionValidTo": "2025-01-01T00:00:00Z",
• "vendor": "Microsoft",
• "upgrades": [

  • {

    • "upgradedLicenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "upgradedQuantity": 1,
    • "quantity": 1

    }

  ],
• "maintenancePeriods": [

  • {

    • "agreementPeriodId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "validFrom": "2024-01-01T00:00:00Z",
    • "validTo": "2025-01-01T00:00:00Z",
    • "hasUpgradeRights": true,
    • "invoiceReference": "INV12345",
    • "notes": "Notes",
    • "maintenanceCost": 1000,
    • "supportCost": 1000

    }

  ],
• "computerAssignments": [

  • {

    • "computerId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "quantity": 1,
    • "virtualMachines": {

      • "0": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

      }

    }

  ],
• "datacenterAssignments": [

  • {

    • "datacenterId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "quantity": 1,
    • "virtualMachines": {

      • "0": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

      }

    }

  ],
• "organizationAssignments": [

  • {

    • "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "quantity": 1

    }

  ],
• "userAssignments": [

  • {

    • "userId": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

    }

  ],
• "siteAssignment": {

  • "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

  },
• "hasVmUseRights": true,
• "numberOfSupportedVirtualMachines": 3

}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "id": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "assignmentTypeId": "8e5d8f69-c818-4575-9a91-aebae9a9eacc",
• "autoAllocateOnce": true,
• "isAutoAllocated": true,
• "metricId": "5891a1d8-7fb0-45bd-b1f6-01c943f9c572",
• "purchaseDate": "2024-01-01T00:00:00Z",
• "purchaseValue": 1000,
• "purchaseCurrency": "USD",
• "quantity": 1,
• "licenseKeys": "69658998-12-12031517-23",
• "mediaStorage": "path/to/file",
• "licenseProofLocation": "path/to/licenseproof",
• "invoiceReference": "INV12345",
• "vendor": "Microsoft",
• "notes": "Notes",
• "externalId": "EXT12345",
• "sku": "ABC-12345-S-BL",
• "productDescription": "MSDN",
• "isSubscription": true,
• "isCrossEdition": true,
• "isCrossPlatform": true,
• "isUpgrade": true,
• "isDowngrade": true,
• "isIncomplete": true,
• "incompleteReasons": {

  • "0": "MissingApplication"

  },
• "contractId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "agreementId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "updatedDate": "2024-01-01T00:00:00Z",
• "createdDate": "2024-01-01T00:00:00Z",
• "subscriptionValidFrom": "2024-01-01T00:00:00Z",
• "subscriptionValidTo": "2025-01-01T00:00:00Z",
• "upgradedLicenseCount": 1,
• "maintenanceAccordingToAgreement": true,
• "skuId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "hasVmUseRights": true,
• "numberOfSupportedVirtualMachines": 100,
• "status": "Active",
• "archivedDate": "2024-01-01T00:00:00Z"

}

Delete license

Removes the given license.

Authorizations:

BearerAuth

path Parameters

id required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}

Response samples

• 400
• 404
• 500

Content type

application/json

{

• "error": {

  • "code": 400,
  • "message": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request."

  }

}

Bulk update licenses

Modifies a collection of licenses.

Authorizations:

BearerAuthBearerAuth

Request Body schema: application/json

filter	string For more information on the available operators and which data types those operators work on, see Filter API call results.
scope required	string Enum Description Only The operation is performed only on the licenses whose IDs are specified. All The operation is performed on all licenses. AllExcept The operation is performed on every license except those whose IDs are specified. The scope of the update operation.
ids	Array of strings <uuid> [ items <uuid > ] The IDs that the operation is performed on.
required	object (LicenseUpdate) The update to be applied to all IDs.
status string Enum Description Active The license is active and affects compliance position. Archived The license is archived and does not affect compliance position. The scope of the update operation.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/bulk-update

Request samples

• Payload

Content type

application/json

{

• "filter": "id -eq '49cdd99f-bc16-40f9-ad40-48f12182fb30'",
• "scope": "Only",
• "ids": [

  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"

  ],
• "body": {

  • "status": "Archived"

  }

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "successCount": 10,
• "failedCount": 10,
• "failed": {

  • "0": "e192ea5e-363c-47e4-82e3-d2587afada8c"

  },
• "failureReason": "These licenses are used as base licenses."

}

Periods

Get maintenance and support periods

Returns a collection of maintenance and support periods.

Authorizations:

BearerAuth

query Parameters

filter	string Example: filter=filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/maintenance-periods

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "agreementPeriodId": "17597d2f-ae4b-4505-a85d-52a78421873c",
    • "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "validFrom": "2024-01-01T00:00:00Z",
    • "validTo": "2025-01-01T00:00:00Z",
    • "hasUpgradeRights": true,
    • "invoiceReference": "INV12345",
    • "notes": "Notes",
    • "maintenanceCost": 1000,
    • "supportCost": 1000,
    • "purchaseCurrency": "USD"

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get license's maintenance and support periods

Returns a collection of maintenance and support periods.

Authorizations:

BearerAuth

path Parameters

id required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.

query Parameters

filter	string Example: filter=filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/maintenance-periods

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "agreementPeriodId": "17597d2f-ae4b-4505-a85d-52a78421873c",
    • "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "validFrom": "2024-01-01T00:00:00Z",
    • "validTo": "2025-01-01T00:00:00Z",
    • "hasUpgradeRights": true,
    • "invoiceReference": "INV12345",
    • "notes": "Notes",
    • "maintenanceCost": 1000,
    • "supportCost": 1000,
    • "purchaseCurrency": "USD"

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Add maintenance and support period

Creates a maintenance and support period.

Authorizations:

BearerAuth

path Parameters

id required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.

Request Body schema: application/json

agreementPeriodId	string or null <guid> The unique ID of the agreement period.
validFrom	string or null <date-time> The valid form date.
validTo	string or null <date-time> The valid to date.
hasUpgradeRights	boolean true if has upgrade rights; otherwise, false.
invoiceReference	string or null The invoice reference.
notes	string or null The notes.
maintenanceCost	number or null <decimal> The maintenance cost.
supportCost	number or null <decimal> The support cost.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/maintenance-periods

Request samples

• Payload

Content type

application/json

{

• "agreementPeriodId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "validFrom": "2024-01-01T00:00:00Z",
• "validTo": "2025-01-01T00:00:00Z",
• "hasUpgradeRights": true,
• "invoiceReference": "INV12345",
• "notes": "Notes",
• "maintenanceCost": 1000,
• "supportCost": 1000

}

Response samples

• 201
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "id": "string"

}

Replace maintenance and support periods

Replaces the given license’s maintenance and support periods.

Authorizations:

BearerAuth

path Parameters

id required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.

Request Body schema: application/json

Array

agreementPeriodId	string or null <guid> The unique ID of the agreement period.
validFrom	string or null <date-time> The valid form date.
validTo	string or null <date-time> The valid to date.
hasUpgradeRights	boolean true if has upgrade rights; otherwise, false.
invoiceReference	string or null The invoice reference.
notes	string or null The notes.
maintenanceCost	number or null <decimal> The maintenance cost.
supportCost	number or null <decimal> The support cost.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/maintenance-periods

Request samples

• Payload

Content type

application/json

[

• {

  • "agreementPeriodId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
  • "validFrom": "2024-01-01T00:00:00Z",
  • "validTo": "2025-01-01T00:00:00Z",
  • "hasUpgradeRights": true,
  • "invoiceReference": "INV12345",
  • "notes": "Notes",
  • "maintenanceCost": 1000,
  • "supportCost": 1000

  }

]

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "agreementPeriodId": "17597d2f-ae4b-4505-a85d-52a78421873c",
    • "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "validFrom": "2024-01-01T00:00:00Z",
    • "validTo": "2025-01-01T00:00:00Z",
    • "hasUpgradeRights": true,
    • "invoiceReference": "INV12345",
    • "notes": "Notes",
    • "maintenanceCost": 1000,
    • "supportCost": 1000,
    • "purchaseCurrency": "USD"

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Delete maintenance and support periods

Removes the given license’s maintenance and support periods.

Authorizations:

BearerAuth

path Parameters

id required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/maintenance-periods

Response samples

• 400
• 404
• 500

Content type

application/json

{

• "error": {

  • "code": 400,
  • "message": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request."

  }

}

Replace maintenance and support period

Replaces the given maintenance and support period.

Authorizations:

BearerAuth

path Parameters

id required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.
periodId required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the maintenance and support period.

Request Body schema: application/json

agreementPeriodId	string or null <guid> The unique ID of the agreement period.
validFrom	string or null <date-time> The valid form date.
validTo	string or null <date-time> The valid to date.
hasUpgradeRights	boolean true if has upgrade rights; otherwise, false.
invoiceReference	string or null The invoice reference.
notes	string or null The notes.
maintenanceCost	number or null <decimal> The maintenance cost.
supportCost	number or null <decimal> The support cost.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/maintenance-periods/{periodId}

Request samples

• Payload

Content type

application/json

{

• "agreementPeriodId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "validFrom": "2024-01-01T00:00:00Z",
• "validTo": "2025-01-01T00:00:00Z",
• "hasUpgradeRights": true,
• "invoiceReference": "INV12345",
• "notes": "Notes",
• "maintenanceCost": 1000,
• "supportCost": 1000

}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "id": "string",
• "validFrom": "2024-01-01T00:00:00Z",
• "validTo": "2025-01-01T00:00:00Z",
• "hasUpgradeRights": true,
• "maintenanceCost": 1000,
• "supportCost": 1000,
• "purchaseCurrency": "USD",
• "invoiceReference": "INV12345",
• "notes": "Notes"

}

Delete maintenance and support period

Removes the given maintenance and support period.

Authorizations:

BearerAuth

path Parameters

id required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.
periodId required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the maintenance and support period.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/maintenance-periods/{periodId}

Response samples

• 400
• 404
• 500

Content type

application/json

{

• "error": {

  • "code": 400,
  • "message": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request."

  }

}

Policies

Get license policy fields

Returns a collection of license policy fields.

Authorizations:

BearerAuth

path Parameters

policyId required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the policy.

query Parameters

filter	string Example: filter=filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses-policies/{policyId}/fields

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "name": "InvoiceReference",
    • "description": "InvoiceReference",
    • "isRequired": true,
    • "isComboBox": true,
    • "isEditingAllowed": true,
    • "listItems": {

      • "0": "Item"

      }

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get license policy field details

Returns the details of a license policy field.

Authorizations:

BearerAuth

path Parameters

policyId required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the policy.
fieldId required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the policy field.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses-policies/{policyId}/fields/{fieldId}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "id": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "name": "InvoiceReference",
• "description": "InvoiceReference",
• "isRequired": true,
• "isComboBox": true,
• "isEditingAllowed": true,
• "listItems": {

  • "0": "Item"

  }

}

Get license policies

Returns a collection of license policies.

Authorizations:

BearerAuth

query Parameters

filter	string Example: filter=filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses-policies

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get license policy details

Returns the details of a license policy.

Authorizations:

BearerAuth

path Parameters

policyId required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the policy.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses-policies/{policyId}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "id": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

}

Tracking

Get computer license tracking

Returns a collection of application license tracking for a given computer.

Authorizations:

BearerAuth

path Parameters

computerId required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the computer.

query Parameters

filter	string Example: filter=filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/tracking-computers/{computerId}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "metricId": "5891a1d8-7fb0-45bd-b1f6-01c943f9c572",
    • "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "computerId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "primaryUseRights": {

      • "0": "NamedComputer"

      }

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get computer license tracking for a given application

Returns a collection of computer license tracking.

Authorizations:

BearerAuth

path Parameters

applicationId required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the application.

query Parameters

filter	string Example: filter=filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/tracking/{applicationId}/computers

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "metricId": "5891a1d8-7fb0-45bd-b1f6-01c943f9c572",
    • "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "computerId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "coverageTrait": 1,
    • "initialRequirement": 1,
    • "requirement": 1,
    • "receivedCoverage": 1,
    • "primaryUseRights": {

      • "0": "NamedComputer"

      },
    • "fullUseRights": {

      • "0": "NamedComputer",
      • "1": "UpgradeRights"

      }

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get application license tracking for a computer

Returns a collection of application license tracking for a given computer.

Authorizations:

BearerAuth

path Parameters

applicationId required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the application.
computerId required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the computer.

query Parameters

filter	string Example: filter=filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/tracking/{applicationId}/computers/{computerId}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "metricId": "5891a1d8-7fb0-45bd-b1f6-01c943f9c572",
    • "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "computerId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "coverageTrait": 1,
    • "initialRequirement": 1,
    • "requirement": 1,
    • "receivedCoverage": 1,
    • "primaryUseRights": {

      • "0": "NamedComputer"

      },
    • "fullUseRights": {

      • "0": "NamedComputer",
      • "1": "UpgradeRights"

      }

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get application license tracking details

Returns a collection of license tracking for an application.

Authorizations:

BearerAuth

path Parameters

applicationId required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the application.

query Parameters

filter	string Example: filter=filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/tracking/{applicationId}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "hasComputerTracking": true,
    • "hasUserTracking": true

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get user license tracking for application

Returns a collection of users license tracking.

Authorizations:

BearerAuth

path Parameters

applicationId required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the application.

query Parameters

filter	string Example: filter=filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/tracking/{applicationId}/users

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "metricId": "5891a1d8-7fb0-45bd-b1f6-01c943f9c572",
    • "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "userId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "coverageTrait": 1,
    • "initialRequirement": 1,
    • "receivedCoverage": 1,
    • "primaryUseRights": {

      • "0": "NamedComputer"

      },
    • "fullUseRights": {

      • "0": "NamedComputer",
      • "1": "UpgradeRights"

      }

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get user license tracking for application

Returns a collection of license tracking for a given user.

Authorizations:

BearerAuth

path Parameters

applicationId required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the application.
userId required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the user.

query Parameters

filter	string Example: filter=filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/tracking/{applicationId}/users/{userId}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "metricId": "5891a1d8-7fb0-45bd-b1f6-01c943f9c572",
    • "applicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "userId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "coverageTrait": 1,
    • "initialRequirement": 1,
    • "receivedCoverage": 1,
    • "primaryUseRights": {

      • "0": "NamedComputer"

      },
    • "fullUseRights": {

      • "0": "NamedComputer",
      • "1": "UpgradeRights"

      }

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Transfers

Get application license transfers

Returns a collection of computer license transfers for an application.

Authorizations:

BearerAuth

path Parameters

applicationId required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the application.

query Parameters

filter	string Example: filter=filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/transfers/{applicationId}/computers

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "computerId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "fromApplicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "toApplicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get application license transfers for a computer

Returns a collection of license transfers for specific application on a computer.

Authorizations:

BearerAuth

path Parameters

applicationId required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the application.
computerId required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the computer.

query Parameters

filter	string Example: filter=filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/transfers/{applicationId}/computers/{computerId}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "metricId": "5891a1d8-7fb0-45bd-b1f6-01c943f9c572",
    • "fromApplicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "toApplicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "computerId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "isUpgrade": true,
    • "isDowngrade": true,
    • "isCrossEdition": true,
    • "isCrossPlatform": true,
    • "quantity": 1

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get custom value license transfers

Returns a collection of custom value license transfers.

Authorizations:

BearerAuth

path Parameters

applicationId required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the application.

query Parameters

filter	string Example: filter=filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/transfers/{applicationId}/custom-values

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "customCompareValueId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "fromApplicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "toApplicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get application license custom value transfers

Returns a collection of license transfers for a given custom value.

Authorizations:

BearerAuth

path Parameters

applicationId required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the application.
customId required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the custom compare value.

query Parameters

filter	string Example: filter=filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/transfers/{applicationId}/custom-values/{customId}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "metricId": "5891a1d8-7fb0-45bd-b1f6-01c943f9c572",
    • "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "customCompareValueId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "fromApplicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "toApplicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "isUpgrade": true,
    • "isDowngrade": true,
    • "isCrossEdition": true,
    • "isCrossPlatform": true,
    • "quantity": 1,
    • "useRights": {

      • "0": "Standard"

      }

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get application license transfers

Returns a collection of license transfers for an application.

Authorizations:

BearerAuth

path Parameters

applicationId required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the application.

query Parameters

filter	string Example: filter=filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/transfers/{applicationId}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "hasComputerTransfer": true,
    • "hasUserTransfer": true,
    • "hasCustomCompareValueTransfer": true

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get users license transfer details

Returns a collection of user license transfers.

Authorizations:

BearerAuth

path Parameters

applicationId required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the application.

query Parameters

filter	string Example: filter=filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/transfers/{applicationId}/users

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "userId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "fromApplicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "toApplicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30"

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get user license transfer details

Returns a collection of license transfers for a given user.

Authorizations:

BearerAuth

path Parameters

applicationId required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the application.
userId required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the user.

query Parameters

filter	string Example: filter=filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/transfers/{applicationId}/users/{userId}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "metricId": "5891a1d8-7fb0-45bd-b1f6-01c943f9c572",
    • "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "organizationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "userId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "fromApplicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "toApplicationId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "isUpgrade": true,
    • "isDowngrade": true,
    • "isCrossPlatform": true,
    • "isCrossEdition": true,
    • "quantity": 1

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Upgrades

Get license upgrades

Returns a collection of upgrades for a license.

Authorizations:

BearerAuth

path Parameters

id required

string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.

query Parameters

filter	string Example: filter=filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/upgrades

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "/api/custom-fields/v1/custom-fields",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "quantity": 1,
    • "upgradedLicenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
    • "upgradedQuantity": 1

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get the details of a license upgrade

Returns the details of a license upgrade.

Authorizations:

BearerAuth

path Parameters

id required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the license.
upgradedLicenseId required	string Example: 49cdd99f-bc16-40f9-ad40-48f12182fb30 The unique ID of the upgraded license.

Responses

You can find your Data region in the Snow Atlas settings menu, in License details. Your Data region is on the General information tab. For further information, see General information.

https://{region}.snowsoftware.io/api/sam/v1/licenses/{id}/upgrades/{upgradedLicenseId}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "licenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "quantity": 1,
• "upgradedLicenseId": "49cdd99f-bc16-40f9-ad40-48f12182fb30",
• "upgradedQuantity": 1

}