##############
Utils and Misc
##############

*****************
Utils endpoints
*****************

These endpoints provide various tools and utilities

Job ID status
=============

.. http:get:: /explore/job/{job_id}
   :noindex:

   Get status of running job or results from completed job

   :query *required* **job_id** (string): 
        * Job ID 

   :query *optional* **max_wait** =<n> (int): 
        * max number of seconds to wait for results before returning status of running job 
        * use when results are preferred over job status information, when job is likely to complete soon

            * 25 (default)
            * value in the range from 0 to 25

   :query *optional* **status_only** =<0|1> (int): 
        * always return job status, even if job is complete 

            * 0 (default) - return results, if available, otherwise curren job status
            * 1 - always return job status, even if results are available

   :query *optional* **force_metadata_on** =<0|1> (int): 
        * always return query metadata, even if original request did not include metadata

            * 0 (default) - return original request
            * 1 - always return metadata

   :query *optional* **force_metadata_off** =<0|1> (int): 
        * never return query metadata, even if original request did include metadata 

            * 0 (default) - return original request
            * 1 - never return metadata

   :requestheader X-API-KEY: `api-key`

**Example Request**

.. sourcecode:: bash
  
   https://api.silentpush.com/api/v1/merge-api/explore/job/d4067541-eafb-424c-98d3-de12d7a91331

**Example Response**

.. sourcecode:: json

    {
        "status_code": 200,
        "error": null,
        "response": {
            "job_status": {
                "get": "https://api.silentpush.com/api/v1/merge-api/explore/job/cd4067541-eafb-424c-98d3-de12d7a91331",
                "job_id": "d4067541-eafb-424c-98d3-de12d7a91331",
                "status": "STARTED"
            }
        }
    }

ASN lookup
=============

.. http:get:: /explore/asn/lookup
   :noindex:

   Show all ASNs with name matching the query parameter

   :query *optional* **asname** =<name> (string):
        * show all AS Names beginning with string

   :query *optional* **asname_starts_with** =<name> (string):
        * show all AS Names beginning with string

   :query *optional* **asname_contains** =<name> (string):
        * show all AS Names containing string
    
   :query *optional* **asnum** =<n> (int):
        * show AS Name for AS Number

   :requestheader X-API-KEY: `api-key`

.. tip::

    This can be used to check which ASNs will be included when the asname parameters are used in other API endpoints

**Example Request**

.. sourcecode:: bash
  
   https://api.silentpush.com/api/v1/merge-api/explore/asn/lookup?asname=microsoft

**Example Response**

.. sourcecode:: json

    {
        "status_code": 200,
        "error": null,
        "response": {
            "records": [
                {
                    "asn": 3598,
                    "asname": "MICROSOFT-CORP-AS US"
                },
                {
                    "asn": 5761,
                    "asname": "MICROSOFT-CORP-MSN-AS-SATURN US"
                },
                {
                    "asn": 6182,
                    "asname": "MICROSOFT-CORP-MSN-AS-4 US"
                },
                {
                    "asn": 6291,
                    "asname": "MICROSOFT-CORP-MSN-AS US"
                },
                {
                    "asn": 6584,
                    "asname": "MICROSOFT-GP-AS US"
                },
                {
                    "asn": 8068,
                    "asname": "MICROSOFT-CORP-MSN-AS-BLOCK US"
                },
                {
                    "asn": 8069,
                    "asname": "MICROSOFT-CORP-MSN-AS-BLOCK US"
                },
                {
                    "asn": 8070,
                    "asname": "MICROSOFT-CORP-MSN-AS-BLOCK US"
                },
                {
                    "asn": 8071,
                    "asname": "MICROSOFT-CORP-MSN-AS-BLOCK US"
                },
                {
                    "asn": 8072,
                    "asname": "MICROSOFT-CORP-MSN-AS-BLOCK US"
                },
                {
                    "asn": 8073,
                    "asname": "MICROSOFT-CORP-MSN-AS-BLOCK US"
                },
                {
                    "asn": 8074,
                    "asname": "MICROSOFT-CORP-MSN-AS-BLOCK US"
                },
                {
                    "asn": 8075,
                    "asname": "MICROSOFT-CORP-MSN-AS-BLOCK US"
                },
                {
                    "asn": 12076,
                    "asname": "MICROSOFT US"
                },
                {
                    "asn": 13399,
                    "asname": "MICROSOFT-CORP-MSN-AS-2 US"
                },
                {
                    "asn": 14719,
                    "asname": "MICROSOFT-CORP-BCENTRAL US"
                },
                {
                    "asn": 20046,
                    "asname": "MICROSOFT-BOS US"
                },
                {
                    "asn": 23468,
                    "asname": "MICROSOFT-CORP-XBOX-ONLINE US"
                },
                {
                    "asn": 35106,
                    "asname": "MICROSOFT-LIVE-MEETING GB"
                },
                {
                    "asn": 45139,
                    "asname": "MICROSOFT-AS-AP Microsoft Corp SG"
                },
                {
                    "asn": 52985,
                    "asname": "Microsoft do Brasil Imp. e Com. Software e Video G BR"
                },
                {
                    "asn": 395496,
                    "asname": "MICROSOFT-CORP-AS-BLOCK-MSIT3 US"
                },
                {
                    "asn": 395524,
                    "asname": "MICROSOFT-CORP-AS-BLOCK-MSIT4 US"
                },
                {
                    "asn": 395851,
                    "asname": "MICROSOFT-CORP-AS-BLOCK-MSIT2 US"
                },
                {
                    "asn": 396463,
                    "asname": "MICROSOFT-CORP-AS-BLOCK-MSIT US"
                },
                {
                    "asn": 398575,
                    "asname": "MICROSOFT-AZURE-ORBITAL US"
                },
                {
                    "asn": 398656,
                    "asname": "MICROSOFT-AZURE-DEDICATED US"
                },
                {
                    "asn": 398657,
                    "asname": "MICROSOFT-AZURE-DEDICATED US"
                },
                {
                    "asn": 398658,
                    "asname": "MICROSOFT-AZURE-DEDICATED US"
                },
                {
                    "asn": 398659,
                    "asname": "MICROSOFT-AZURE-DEDICATED US"
                },
                {
                    "asn": 398660,
                    "asname": "MICROSOFT-AZURE-DEDICATED US"
                },
                {
                    "asn": 398661,
                    "asname": "MICROSOFT-AZURE-DEDICATED US"
                }
            ]
        }
    }