Fetching a list of resources by type

  1. Authenticate to the cloud platform via the Python shell.

    The following variables should be available now:

    >>> base_url  # the base URL of the API
    >>> auth  # the 'Authorization' header value with the access token
    {'Authorization': 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6ImMwMD...'}
  2. Define a variable named filters, and then assign an object containing the type query string parameter to this variable:

    >>> filters = {
    ...     'type': 'resource.machine'
    ... }

    For the list of available query string parameters, refer to the API reference.


    To fetch resources by multiple types, provide the values in the following format: or(resource.machine,resource.mssql_server)

  3. Send a GET request to the /resource_management/v4/resources endpoint:

    >>> response = requests.get(
    ...     f'{base_url}/resource_management/v4/resources',
    ...     headers=auth,
    ...     params=filters,
    ... )
  4. Check the status code of the response:

    >>> response.status_code

    Status code 200 means that the request was successful.

    A different status code means that an error has occurred. For the details, refer to “Status and error codes”.

    Also, the response body contains an object with the items key containing an array of resource objects formatted as a JSON text. When converted to an object, it will look as follows:

    >>> pprint.pprint(response.json())
    {'items': [{'created_at': '2021-02-03T14:57:07.293995787Z',
                'external_id': '23effcf6-2798-4631-9a52-5785bf3af657@17',
                'id': '23effcf6-2798-4631-9a52-5785bf3af657',
                'name': 'DESKTOP-JRPTA4A',
                'tenant_id': '17',
                'type': 'resource.machine',
                'updated_at': '2021-02-03T18:13:48.312293448Z',
                'user_defined_name': 'DESKTOP-JRPTA4A'}],
    'paging': {'cursors': {'total': 1}}}