NAV
shell python

Introduction

Welcome to the Yangcatalog API! You can use our API to access information on various yang modules in our database. To test out the various endpoints on Postman, you can download our Postman collection here

We have examples in Shell and Python! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs to the top right.

This example API documentation page was created with Slate. Feel free to edit it, create a pull request or issue if you find anything that doesn`t work as expected.

Contribute

This section is for users who wants to directly contribute yang modules to the yangcatalog.org database without using the YangModels/yang repository, adding files from their own repository instead. For this you need to have access credentials which you'll create by creating an account on yangcatalog.org. Full description on how to proceed can be found on contribute page

Update model metadata

import requests

url = 'https://yangcatalog.org/api/modules'
body = <data>
requests.put(url, body, auth=('admin', 'admin'),
    headers={'Accept': 'application/json', 'Content-type': 'application/json'})

curl -X PUT -H "Accept: application/json" -H "Content-type: application/json"
 --user admin:admin "https://yangcatalog.org/api/modules"
 --data '<data>'

Make sure to replace admin admin with your name and password.

The above command uses data like this:

{
  "modules": {
    "module": [
      {
        "name": "example-jukebox",
        "revision": "2014-01-20",
        "organization": "example",
        "maturity-level": "ratified",
        "author-email": "foo@bar.com",
        "module-classification": "network-element",
        "source-file": {
          "repository": "foo",
          "owner": "bar",
          "path": "standard/ietf/DRAFT/example-jukebox.yang"
        }
      }
    ]
  }
}

The above command returns JSON structured like this:

{
  "info": "Verification successful",
  "job-id": "88bd8c4c-8809-4de8-85c8-39d522d4bcdf"
}

This endpoint serves to add and update all the modules from the json provided as the body of the request. It will parse all the modules on the provided paths. Since this job takes some time the the endpoint will respond only with verification information and a job-id on which you can track the job status.

HTTP Request

PUT https://yangcatalog.org/api/modules

Body Parameters

Inside of the body we need to provide a list of modules with the following, parameters for each module

Parameter Description
name Name of the yang module
revision Revision of the yang module
organization Organization of the yang module
maturity-level ratified, adopted, initial not-applicable (more information at yangcatalog RFC)
author-email Email of the author that created this module
module-classification network-service, network-element, unknown, not-applicable (RFC8199 YANG Module Classification)
source-file Object with source file information
repository Name of the repository
owner Name of the owner of the repository
path Path in the repository for the given yang module

Add model metadata

import requests

url = 'https://yangcatalog.org/api/modules'
body = <data>
requests.post(url, body, auth=('admin', 'admin'),
    headers={'Accept': 'application/json', 'Content-type': 'application/json'})

curl -X POST -H "Accept: application/json" -H "Content-type: application/json"
 --user admin:admin "https://yangcatalog.org/api/modules"
 --data '<data>'

Make sure to replace admin admin with your name and password.

The above command uses data like this:

{
  "modules": {
    "module": [{
      "name": "example-jukebox",
      "revision": "2014-01-20",
      "organization": "example",
      "maturity-level": "ratified",
      "author-email": "foo@bar.com",
      "module-classification": "network-element",
      "source-file": {
        "repository": "foo",
        "owner": "bar",
        "path": "standard/ietf/DRAFT/example-jukebox.yang"
      }
    }]
  }
}

The above command returns JSON structured like this:

{
  "info": "Verification successful",
  "job-id": "88bd8c4c-8809-4de8-85c8-39d522d4bcdf"
}

This endpoint serves to add all the modules from the json provided as the body of the request. If a module already exist with the given name and revision, the module will not be updated or added, instead it will be skipped and ignored. Next it will parse the rest of the modules on the provided paths. Since this job takes some time, the endpoint will respond only with verification information and a job-id on which you can track the job status.

HTTP Request

POST https://yangcatalog.org/api/modules

Body Parameters

Inside of the body we need to provide a list of modules with following, parameters for each module

Parameter Description
name Name of the yang module
revision Revision of the yang module
organization Organization of the yang module
maturity-level ratified, adopted, initial not-applicable (more information at yangcatalog RFC)
author-email Email of the author that created this module
module-classification network-service, network-element, unknown, not-applicable (RFC8199 YANG Module Classification)
source-file Object with source file information
repository Name of the repository
owner Name of the owner of the repository
path Path in the repository for the given yang module

Update implementation metadata

import requests

url = 'https://yangcatalog.org/api/platforms'
body = <data>
requests.put(url, body, auth=('admin', 'admin'),
    headers={'Accept': 'application/json', 'Content-type': 'application/json'})

curl -X PUT -H "Accept: application/json" -H "Content-type: application/json"
 --user admin:admin "https://yangcatalog.org/api/platforms"
 --data '<data>'

Make sure to replace admin admin with your name and password.

The above command uses data like this:

{
  "platforms": {
    "platform": [
      {
        "vendor": "example",
        "name": "baz",
        "module-list-file": {
          "type": "capabilities",
          "repository": "foo",
          "owner": "bar",
          "path": "vendor/example/baz/baz-netconf-capability.xml"
        },
        "platform-ids": [
          "BAZ4000", "BAZ4100"
        ],
        "software-flavor": "ALL",
        "software-version": "1.2.3",
        "os-type": "bazOS"
      }
    ]
  }
}

The above command returns JSON structured like this:

{
  "info": "Verification successful",
  "job-id": "88bd8c4c-8809-4de8-85c8-39d522d4bcdf"
}

This endpoint serves to add or update all the modules from the path provided in the json, which should be a path to a capabilities.xml file or to a yang-library file which is constructed according to RFC7895. Next it will parse all the modules in the provided xml files. Since this job takes some time, the endpoint will respond only with verification information and a job-id on which you can track the job status.

HTTP Request

PUT https://yangcatalog.org/api/platforms

Body Parameters

Inside of the body we need to provide a list of platforms with following, parameters for each platform

Parameter Description
vendor Name of the vendor (example: cisco or ciena)
name Platform on which this module is implemented
module-list-file Object with source file information
type capabilities or yang-library
repository Name of the repository
owner Name of the owner of the repository
path Path in the repository for the given "type" file
platform-ids The specific product ID or IDs to which this data applies
software-flavor A variation of a specific version where YANG model support may be different
software-version Name of the version of software
os-type Type of the operating system using the module

Add implementation metadata

import requests

url = 'https://yangcatalog.org/api/platforms'
body = <data>
requests.post(url, body, auth=('admin', 'admin'),
    headers={'Accept': 'application/json', 'Content-type': 'application/json'})

curl -X POST -H "Accept: application/json" -H "Content-type: application/json"
 --user admin:admin "https://yangcatalog.org/api/platforms"
 --data '<data>'

Make sure to replace admin admin with your name and password.

The above command uses data like this:

{
  "platforms": {
    "platform": [
      {
        "vendor": "example",
        "name": "baz",
        "module-list-file": {
          "type": "capabilities",
          "repository": "foo",
          "owner": "bar",
          "path": "vendor/example/baz/baz-netconf-capability.xml"
        },
        "platform-ids": [
          "BAZ4000", "BAZ4100"
        ],
        "software-flavor": "ALL",
        "software-version": "1.2.3",
        "os-type": "bazOS"
      }
    ]
  }
}

The above command returns JSON structured like this:

{
  "info": "Verification successful",
  "job-id": "88bd8c4c-8809-4de8-85c8-39d522d4bcdf"
}

This endpoint serves to add all the modules from the path provided in the json, which should be a path to a capabilities xml file or to a yang-library file which is constructed according to RFC7895. This will only parse new capability files. If the file already exist it will skip this file. Next it will parse all the modules in the provided xml files. Since this job takes some time, the endpoint will respond only with verification information and a job-id on which you can track the job status.

HTTP Request

POST https://yangcatalog.org/api/platforms

Body Parameters

Inside of the body we need to provide a list of platforms with following parameters for each platform

Parameter Description
vendor Name of the vendor (example: cisco or ciena)
name Platform on which this module is implemented
module-list-file Object with source file information
type capabilities or yang-library
repository Name of the repository
owner Name of the owner of the repository
path Path in the repository for the given "type" file
platform-ids The specific product ID or IDs to which this data applies
software-flavor A variation of a specific version where YANG model support may be different
software-version Name of the version of software
os-type Type of the operating system using the module

Delete models metadata

import requests

url = 'https://yangcatalog.org/api/modules'
body = <data>
requests.delete(url, body, auth=('admin', 'admin'),
    headers={'Accept': 'application/json', 'Content-type': 'application/json'})

curl -X DELETE -H "Accept: application/json" -H "Content-type: application/json"
 --user admin:admin "https://yangcatalog.org/api/modules"
 --data '<data>'

Make sure to replace admin admin with your name and password.

The above command uses data like this:

{
  "input": {
    "modules": [{
        "name": "<name>",
        "revision": "<revision>",
        "organization": "<organization>"
    }]
  }
}

The above command returns JSON structured like this:

{
  "info": "Verification successful",
  "job-id": "88bd8c4c-8809-4de8-85c8-39d522d4bcdf"
}

This endpoint serves to remove all the modules provided in the json. Modules is a list of modules that contain the main information about a module, which is the name, revision, organization. Since this job takes some time, the endpoint will respond only with verification information and job-id on which you can track the job status.

HTTP Request

DELETE https://yangcatalog.org/api/modules

Body Parameters

Inside of the body we need to provide a list of modules with following, parameters for each platform

Parameter Description
name Name of the module
revision Revision of the module
organization Organization of the module

Delete model metadata

import requests

url = 'https://yangcatalog.org/api/modules/module/<name>,<revision>,<organization>'
requests.delete(url, auth=('admin', 'admin'),
    headers={'Accept': 'application/json', 'Content-type': 'application/json'})

curl -X DELETE -H "Accept: application/json" -H "Content-type: application/json"
 --user admin:admin "https://yangcatalog.org/api/modules/module/<name>,<revision>,<organization>"

Make sure to replace admin admin with your name and password.

The above command returns JSON structured like this:

{
  "info": "Verification successful",
  "job-id": "88bd8c4c-8809-4de8-85c8-39d522d4bcdf"
}

This endpoint serves to remove the specific module on the provided path. Since this job takes some time the endpoint will respond only with verification information and job-id on which you can track the job status.

HTTP Request

DELETE https://yangcatalog.org/api/modules/module/<name>,<revision>,<organization>

URL Parameters

Parameter Description
name Name of the module
revision Revision of the module
organization Organization of the module

Delete implementation metadata

import requests

url = 'https://yangcatalog.org/api/vendors/<path:value>'
requests.delete(url, auth=('admin', 'admin'),
    headers={'Accept': 'application/json', 'Content-type': 'application/json'})

curl -X DELETE -H "Accept: application/json" -H "Content-type: application/json"
 --user admin:admin "https://yangcatalog.org/api/vendors/<path:value>"

Make sure to replace admin admin with your name and password.

The above command returns JSON structured like this:

{
  "info": "Verification successful",
  "job-id": "88bd8c4c-8809-4de8-85c8-39d522d4bcdf"
}

This endpoint serves to remove all the modules from provided path. Since this job takes some time the endpoint will respond only with verification information and job-id on which you can track the job status.

HTTP Request

DELETE https://yangcatalog.org/api/vendors/<path:value>

URL Parameters

Parameter Description
path:value Path to a specific vendor modules you want to remove (example: vendors/vendor/cisco/platforms/platform/xe would delete all xe cisco modules)

Get job status

import requests

url = 'https://yangcatalog.org/api/job/<job-id>'
requests.get(url, headers={'Accept': 'application/json', 'Content-type': 'application/json'})

curl -X GET -H "Accept: application/json" -H "Content-type: application/json"
 "https://yangcatalog.org/api/job/<job-id>"

The above command returns JSON structured like this:

{
  "info": {
    "job-id": "88bd8c4c-8809-4de8-85c8-39d522d4bcdf",
    "reason": null,
    "result": "In progress"
  }
}

This endpoint serves to get the job status which can be either 'Failed', 'In progress', or 'Finished successfully'.

HTTP Request

GET https://yangcatalog.org/api/job/<job-id>

URL Parameters

Parameter Description
job-id Id of the job provided as a response to any of the above requests

Search

Get whole catalog

import requests

url = 'https://yangcatalog.org/api/search/catalog'
requests.get(url, headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" "https://yangcatalog.org/api/search/catalog"

The above command returns JSON-formatted modules data with all the vendor implementation metadata

This endpoint serves to get all the modules with their vendor implementation metadata

HTTP Request

GET https://yangcatalog.org/api/search/catalog

Get all modules metadata

import requests

url = 'https://yangcatalog.org/api/search/modules'
requests.get(url, headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" "https://yangcatalog.org/api/search/modules"

The above command returns JSON-formatted modules data

This endpoint serves to get all the modules metadata

HTTP Request

GET https://yangcatalog.org/api/search/modules

Get all implementation metadata

import requests

url = 'https://yangcatalog.org/api/search/vendors'
requests.get(url, headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" "https://yangcatalog.org/api/search/vendors"

The above command returns JSON-formatted vendor implementation metadata

This endpoint serves to get all the vendor implementation metadata

HTTP Request

GET https://yangcatalog.org/api/search/vendors

Get specific module

import requests

url = 'https://yangcatalog.org/api/search/modules/<name>,<revision>,<organization>'
requests.get(url, headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" "https://yangcatalog.org/api/search/modules/<name>,<revision>,<organization>"

The above command returns JSON-formatted module data like this:

{
  "yang-catalog:module": {
    "name": "ietf-isis",
    "revision": "2018-08-09",
    "organization": "ietf",
    "namespace": "urn:ietf:params:xml:ns:yang:ietf-isis",
    "schema": "https://raw.githubusercontent.com/YangModels/yang/master/experimental/ietf-extracted-YANG-modules/ietf-isis@2018-08-09.yang",
    "generated-from": "not-applicable",
    "module-classification": "unknown",
    "compilation-status": "passed",
    "compilation-result": "Unknown",
    "prefix": "isis",
    "yang-version": "1.1",
    "description": "The YANG module defines a generic configuration model for\nIS-IS common across all of the vendor implementations.",
    "contact": "WG List:  &lt;mailto:isis-wg@ietf.org&gt;\n\nEditor:    Stephane Litkowski\n     &lt;mailto:stephane.litkowski@orange.com&gt;\n\n   Derek Yeung\n     &lt;mailto:derek@arrcus.com&gt;\n   Acee Lindem\n     &lt;mailto:acee@cisco.com&gt;\n   Jeffrey Zhang\n     &lt;mailto:zzhang@juniper.net&gt;\n   Ladislav Lhotka\n     &lt;mailto:llhotka@nic.cz&gt;\n   Yi Yang\n     &lt;mailto:yiya@cisco.com&gt;\n   Dean Bogdanovic\n     &lt;mailto:deanb@juniper.net&gt;\n   Kiran Agrahara Sreenivasa\n     &lt;mailto:kkoushik@brocade.com&gt;\n   Yingzhen Qu\n     &lt;mailto:yiqu@cisco.com&gt;\n           Jeff Tantsura\n             &lt;mailto:jefftant.ietf@gmail.com&gt;\n\n",
    "module-type": "module",
    "tree-type": "nmda-compatible",
    "yang-tree": "https://yangcatalog.org/api/services/tree/ietf-isis@2018-08-09.yang",
    "expired": "not-applicable",
    "dependencies": [
      {
        "name": "iana-routing-types"
      },
      {
        "name": "ietf-bfd-types"
      },
      {
        "name": "ietf-inet-types"
      },
      {
        "name": "ietf-interfaces"
      },
      {
        "name": "ietf-key-chain"
      },
      {
        "name": "ietf-routing"
      },
      {
        "name": "ietf-routing-types"
      },
      {
        "name": "ietf-yang-types"
      }
    ],
    "dependents": [
      {
        "name": "ietf-bier"
      },
      {
        "name": "ietf-isis-ppr"
      },
      {
        "name": "ietf-isis-sr"
      },
      {
        "name": "ietf-isis-srv6"
      },
      {
        "name": "ietf-rip"
      }
    ],
    "derived-semantic-version": "6.0.0"
  }
}

This endpoint serves to get a specific module's metadata

HTTP Request

GET https://yangcatalog.org/api/search/modules/<name>,<revision>,<organization>

URL Parameters

Parameter Description
name Name of the module
revision Revision of the module
organization Organization of the module

Get implementation metadata

import requests

url = 'https://yangcatalog.org/api/search/vendors/<path:value>'
requests.get(url, headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" "https://yangcatalog.org/api/search/vendors/<path:value>"

The above command returns JSON-formatted implementation metadata

This endpoint serves to get a specific module's metadata

HTTP Request

GET https://yangcatalog.org/api/search/vendors/<path:value>

URL Parameters

Parameter Description
path:value Path to a vendor, platform, software-version or software-flavor (example: vendor/cisco/platforms/platform/ncs5k)

Get organization platform list

import requests

url = 'https://yangcatalog.org/api/search/vendor/<org>'
requests.get(url, headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" "https://yangcatalog.org/api/search/vendor/<org>"

The above command returns JSON-formatted implementation metadata

{
  "IOS-XE": {
    "16.10.1": [
      "CAT9300",
      "IR1101",
      "ASR1000",
      "ASR920",
      "ISR4000",
      "NCS520",
      "ISR1000",
      "CSR1000V",
      "ASR900",
      "CAT9500",
      "CAT9400",
      "NCS4200",
      "CBR-8",
      "CAT9800"
    ],
    "16.11.1": [
      "CAT3650",
      "IE3x00",
      "CAT9300",
      "CAT9200",
    .
    .
    .

This endpoint serves to get all the platforms where a specific organization has yang modules.

HTTP Request

GET https://yangcatalog.org/api/search/vendor/<org>

URL Parameters

Parameter Description
org organization that you are trying to search for (example: cisco would get you all platforms with cisco modules)

Filter leaf data

import requests

url = 'https://yangcatalog.org/api/search/<path:value>'
requests.get(url, headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" "https://yangcatalog.org/api/search/<path:value>"

The above command with path:value = ietf/ietf-wg/netmod returns JSON-formatted yang modules like this:

{
  "yang-catalog:modules": {
    "module": [
      {
        "name": "example-iana-if-type",
        "revision": "2017-06-27",
        "organization": "ietf",
        "ietf": {
          "ietf-wg": "netmod"
        },
        "namespace": "urn:ietf:params:xml:ns:yang:example-iana-if-type",
        "schema": "https://raw.githubusercontent.com/YangModels/yang/master/experimental/ietf-extracted-YANG-modules/example-iana-if-type@2017-06-27.yang",
        "generated-from": "not-applicable",
        "maturity-level": "initial",
        "document-name": "draft-wilton-netmod-interface-properties-00.txt",
        "author-email": "draft-wilton-netmod-interface-properties@ietf.org",
        "reference": "http://datatracker.ietf.org/doc/draft-wilton-netmod-interface-properties",
        "module-classification": "unknown",
        "compilation-status": "unknown",
        "compilation-result": "https://yangcatalog.org/results/example-iana-if-type@2017-06-27_ietf.html",
        "prefix": "ianaift",
        "yang-version": "1.1",
        "description": "This example module illustrates how iana-if-type.yang could\nbe extended to use interface properties.",
        "contact": "",
        "module-type": "module",
        "tree-type": "not-applicable",
        "yang-tree": "https://yangcatalog.org/api/services/tree/example-iana-if-type@2017-06-27.yang",
        "expired": "not-applicable",
        "dependencies": [
          {
            "name": "iana-if-property-type",
            "schema": "https://raw.githubusercontent.com/YangModels/yang/master/experimental/ietf-extracted-YANG-modules/iana-if-property-type@2017-06-27.yang"
          },
          {
            "name": "ietf-interfaces",
            "schema": "https://raw.githubusercontent.com/YangModels/yang/master/experimental/ietf-extracted-YANG-modules/ietf-interfaces@2018-01-09.yang"
          }
        ],
        "derived-semantic-version": "1.0.0"
      },
      {
        "name": "example-ietf-interfaces",
        "revision": "2017-06-27",
        "organization": "ietf",
        "ietf": {
          "ietf-wg": "netmod"
        .
        .
        .

This endpoint serves to get all the modules that correspond with the provided keyword

HTTP Request

GET https://yangcatalog.org/api/search/<path:value>

URL Parameters

Parameter Description
path:value A node/value pair for one of the leaf nodes of the module subtree.

Query Parameters

Parameter Default Description
latest-revision false If set to true, the result will filter only the latest revisions of found yang modules.

RPC search

Filter several leafs

import requests

body = <data>
url = 'https://yangcatalog.org/api/search-filter'
requests.post(url, body, headers={'Accept': 'application/json'})

curl -X POST -H "Accept: application/json" -H "Content-type: application/json"
 --data '<data>'
 "https://yangcatalog.org/api/search-filter"

The above command uses data like this:

{
  "input":{
    "generated-from": "mib",
    "implementations":{
      "implementation":[
        {
          "vendor":"cisco",
          "software-version":"16.8.1"
        }
      ]
    }
  }
}

The above command returns JSON-formatted yang modules like this:

{
  "yang-catalog:modules": {
    "module": [
      {
        "name": "ATM-FORUM-TC-MIB",
        "revision": "1970-01-01",
        "organization": "ietf",
        "namespace": "urn:ietf:params:xml:ns:yang:smiv2:ATM-FORUM-TC-MIB",
        "schema": "https://raw.githubusercontent.com/YangModels/yang/master/vendor/cisco/xe/1681/MIBS/ATM-FORUM-TC-MIB.yang",
        "generated-from": "mib",
        "module-classification": "unknown",
        "compilation-status": "failed",
        "compilation-result": "https://yangcatalog.org/results/ATM-FORUM-TC-MIB@1970-01-01_ietf.html",
        "prefix": "ATM-FORUM-TC-MIB",
        "yang-version": "1.0",
        "module-type": "module",
        "tree-type": "not-applicable",
        "yang-tree": "https://yangcatalog.org/api/services/tree/ATM-FORUM-TC-MIB@1970-01-01.yang",
        "expired": "not-applicable",
        "dependencies": [
          {
            "name": "ietf-yang-smiv2",
            "schema": "https://raw.githubusercontent.com/YangModels/yang/master/standard/ietf/RFC/ietf-yang-smiv2@2012-06-22.yang"
          }
        ],
        "dependents": [
          {
            "name": "CISCO-ATM-QOS-MIB",
            "revision": "2002-06-10",
            "schema": "https://raw.githubusercontent.com/YangModels/yang/master/vendor/cisco/xe/1681/MIBS/CISCO-ATM-QOS-MIB.yang"
          }
        ],
        "derived-semantic-version": "1.0.0",
        "implementations": {
          "implementation": [
            {
              "vendor": "cisco",
              "platform": "ASR1000",
              "software-version": "16.3.1",
              "software-flavor": "ALL",
              "os-ver
        .
        .
        .

This endpoint serves to get all the modules that contain all the leafs with data as provided by <data> in body of the request

HTTP Request

POST https://yangcatalog.org/api/search-filter

Query Parameters

Parameter Default Description
latest-revision false If set to true, the result will filter only the latest revisions of found yang modules.

Body Parameters

Inside of the body we need to start with "input" to which we provide all the leafs with data that need to be filtered out of yangcatalog. All the leafs can be found in draft-clacla-netmod-model-catalog-03 section 2-2

Get common modules

import requests

body = <data>
url = 'https://yangcatalog.org/api/get-common'
requests.post(url, body, headers={'Accept': 'application/json'})

curl -X POST -H "Accept: application/json" -H "Content-type: application/json"
 --data '<data>'
 "https://yangcatalog.org/api/get-common"

The above command uses data like this:

{
  "input":{
    "first":{
      "implementations":{
        "implementation":[
          {
            "vendor":"cisco",
            "software-version":"6.1.1",
            "platform":"asr9k-px"
          }
        ]
      }
    },
    "second":{
      "implementations":{
        "implementation":[
          {
            "vendor":"cisco",
            "software-version":"6.1.3",
            "platform":"asr9k-px"
          }
        ]
      }
    }
  }
}

The above command returns JSON-formatted yang modules like this:

{
  "output": [
    {
      "name": "Cisco-IOS-XR-Ethernet-SPAN-cfg",
      "revision": "2015-11-09",
      "organization": "cisco",
      "namespace": "http://cisco.com/ns/yang/Cisco-IOS-XR-Ethernet-SPAN-cfg",
      "schema": "https://raw.githubusercontent.com/YangModels/yang/master/vendor/cisco/xr/632/Cisco-IOS-XR-Ethernet-SPAN-cfg.yang",
      "generated-from": "native",
      "module-classification": "unknown",
      "compilation-status": "failed",
      "compilation-result": "https://yangcatalog.org/results/Cisco-IOS-XR-Ethernet-SPAN-cfg@2015-11-09_cisco.html",
      "prefix": "ethernet-span-cfg",
      "yang-version": "1.0",
      "description": "This module contains a collection of YANG definitions\nfor Cisco IOS-XR Ethernet-SPAN package configuration.\n\nThis module contains definitions\nfor the following management objects:\n  span-monitor-session: none\n\nThis YANG module augments the\n  Cisco-IOS-XR-ifmgr-cfg,\n  Cisco-IOS-XR-l2vpn-cfg\nmodules with configuration data.\n\nCopyright (c) 2013-2017 by Cisco Systems, Inc.\nAll rights reserved.",
      "contact": "Cisco Systems, Inc.\nCustomer Service\n\nPostal: 170 West Tasman Drive\nSan Jose, CA 95134\n\nTel: +1 800 553-NETS\n\nE-mail: cs-yang@cisco.com",
      "module-type": "module",
      "tree-type": "nmda-compatible",
      "yang-tree": "https://yangcatalog.org/api/services/tree/Cisco-IOS-XR-Ethernet-SPAN-cfg@2015-11-09.yang",
      "expired": "not-applicable",
      "dependencies": [
        {
          "name": "Cisco-IOS-XR-Ethernet-SPAN-datatypes",
          "schema": "https://raw.githubusercontent.com/YangModels/yang/master/vendor/cisco/xr/632/Cisco-IOS-XR-Ethernet-SPAN-datatypes.yang"
        },
        {
          "name": "Cisco-IOS-XR-ifmgr-cfg",
          "schema": "https://raw.githubusercontent.com/YangModels/yang/master/vendor/cisco/xr/632/Cisco-IOS-XR-ifmgr-cfg.yang"
        },
        {
          "name": "Cisco-IOS-XR-l2vpn-cfg",
          "schema": "https://raw.githubusercontent.com/YangModels/yang/master/vendor/cisco/xr/632/Cisco-IOS-XR-l2vpn-cfg.yang"
        },
        {
          "name": "Cisco-IOS-XR-types",
          "schema": "https://raw.githubusercontent.com/YangModels/yang/master/vendor/cisco/xr/632/Cisco-IOS-XR-types.yang"
        },
        {
          "name": "ietf-inet-types",
          "schema": "https://raw.githubusercontent.com/YangModels/yang/master/vendor/cisco/xr/632/ietf-inet-types.yang"
        }
      ],
      "derived-semantic-version": "1.0.0",
      "implementations": {
        "implementation": [
          {
            "vendor": "cisco",
            "platform": "asr9k",
            "software-version": "632",
            "software-flavor": "ALL",
    .
    .
    .

This endpoint serves to get all the common modules between the results of two filters by leafs with data provided in <data> in the body of the request

HTTP Request

POST https://yangcatalog.org/api/get-common

Query Parameters

Parameter Default Description
latest-revision false If set to true, the result will filter only the latest revisions of found yang modules.

Body Parameters

Inside of the body we need to start with an "input" container which needs to contain containers "first" and "second" to which we provide all the leafs with data that need to be filtered out of yangcatalog. All the leafs can be found in draft-clacla-netmod-model-catalog-03 section 2-2

Compare two searches

import requests

body = <data>
url = 'https://yangcatalog.org/api/compare'
requests.post(url, body, headers={'Accept': 'application/json'})

curl -X POST -H "Accept: application/json" -H "Content-type: application/json"
 --data '<data>'
 "https://yangcatalog.org/api/compare"

The above command uses data like this:

{
  "input":{
    "old":{
      "implementations":{
        "implementation":[
          {
            "vendor":"cisco",
            "software-version":"6.1.1",
            "platform":"asr9k-px"
          }
        ]
      }
    },
    "new":{
      "implementations":{
        "implementation":[
          {
            "vendor":"cisco",
            "software-version":"6.1.3",
            "platform":"asr9k-px"
          }
        ]
      }
    }
  }
}

The above command returns JSON-formatted yang modules like this:

{
  "output": [
    {
      "compilation-result": "https://yangcatalog.org/results/Cisco-IOS-XE-umbrella@2017-08-30_cisco.html",
      "compilation-status": "failed",
      "contact": "Cisco Systems, Inc.\nCustomer Service\n\nPostal: 170 W Tasman Drive\nSan Jose, CA 95134\n\nTel: +1 1800 553-NETS\n\nE-mail: cs-yang@cisco.com",
      "dependencies": [
        {
          "name": "Cisco-IOS-XE-native",
          "schema": "https://raw.githubusercontent.com/yangmodels/yang/master/vendor/cisco/xe/1662/Cisco-IOS-XE-native.yang"
        },
        {
          "name": "ietf-inet-types",
          "schema": "https://raw.githubusercontent.com/yangmodels/yang/master/vendor/cisco/xe/1662/ietf-inet-types.yang"
        }
      ],
      "derived-semantic-version": "1.0.0",
      "description": "Cisco XE Native Umbrella Yang model.\nCopyright (c) 2017 by Cisco Systems, Inc.\nAll rights reserved.",
      "expired": "not-applicable",
      "generated-from": "native",
      "implementations": {
        "implementation": [
          {
            "conformance-type": "implement",
            "feature-set": "ALL",
            "os-type": "IOS-XE",
            "os-version": "16.6.2",
            "platform": "CSR1000V",
            "software-flavor": "ALL",
            "software-version": "16.6.2",
            "vendor": "cisco"
          },
          {
            "conformance-type": "implement",
            "feature-set": "ALL",
            "os-type": "IOS-XE",
            "os-version": "16.6.2",
            "platform": "ISR4000",
            "software-flavor": "ALL",
            "software-version": "16.6.2",
            "vendor": "cisco"
          }
        ]
      },
      "maturity-level": "not-applicable",
      "module-classification": "unknown",
      "module-type": "module",
      "name": "Cisco-IOS-XE-umbrella",
      "namespace": "http://cisco.com/ns/yang/Cisco-IOS-XE-umbrella",
      "organization": "cisco",
      "prefix": "ios-umbrella",
      "reason-to-show": "New module",
      "revision": "2017-08-30",
      "schema": "https://raw.githubusercontent.com/YangModels/yang/0aa291b720ee6f013966f9bcbea9375671457ee9/vendor/cisco/xe/1662/Cisco-IOS-XE-umbrella.yang",
      "tree-type": "nmda-compatible",
      "yang-tree": "https://yangcatalog.org/api/services/tree/Cisco-IOS-XE-umbrella@2017-08-30.yang",
      "yang-version": "1.0"
    },
    .
    .
    .

This endpoint serves to compare and find differences between the results of filters by leafs with data provided in <data> in the body of the request. Output also contains module metadata with reason-to-show data which shows either 'New module' or 'Different revision'

HTTP Request

POST https://yangcatalog.org/api/compare

Query Parameters

Parameter Default Description
latest-revision false If set to true, the result will filter only for latest revision of found yang modules.

Body Parameters

Inside of the body we need to start with a "input" container which needs to contain containers "new" and "old" to which we provide all the leafs with data that need to be filtered out of yangcatalog. All the leafs can be found in draft-clacla-netmod-model-catalog-03 section 2-2

Services

Get tree

import requests

url = 'https://yangcatalog.org/api/services/tree/<name>@<revision>.yang'
requests.get(url, body, headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" -H "Content-type: application/json"
 "https://yangcatalog.org/api/services/tree/<name>@<revision>.yang"

The above command returns HTML-formatted tree of the module like this:

<html><body><pre>module: example-ietf-interfaces
  +--ro interfaces-state
     +--ro interface* [name]
        +--ro name          string
        +--ro type          identityref
        +--ro statistics
           +--ro discontinuity-time    yang:date-and-time
           +--ro in-octets?            yang:counter64
           +--ro in-unicast-pkts?      yang:counter64
           +--ro in-broadcast-pkts?    yang:counter64
           +--ro in-multicast-pkts?    yang:counter64
</pre></body></html>

This endpoint serves to get tree of a specific yang module

HTTP Request

GET https://yangcatalog.org/api/services/tree/<name>@<revision>.yang

URL Parameters

Parameter Description
name Name of the yang file
revision Revision of the yang file

Get schema of the module

import requests

url = 'https://yangcatalog.org/api/services/reference/<name>@<revision>.yang'
requests.get(url, body, headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" -H "Content-type: application/json"
 "https://yangcatalog.org/api/services/reference/<name>@<revision>.yang"

The above command returns HTML-formatted schema of the module like this:

<html><body><pre>module ietf-te-device {

  namespace "urn:ietf:params:xml:ns:yang:ietf-te-device";

  /* Replace with IANA when assigned */
  prefix "te-dev";

  /* Import TE generic types */
  import ietf-te {
    prefix te;
  }
  .
  .
  .
</pre></body></html>

This endpoint serves to get the reference schema of a specific yang module

HTTP Request

GET https://yangcatalog.org/api/services/reference/<name>@<revision>.yang

URL Parameters

Parameter Description
name Name of the yang file
revision Revision of the yang file

Get semantic differences

import requests

body = <data>
url = 'https://yangcatalog.org/api/check-semantic-version'
requests.post(url, body, headers={'Accept': 'application/json'})

curl -X POST -H "Accept: application/json" -H "Content-type: application/json"
 --data '<data>'
 "https://yangcatalog.org/api/check-semantic-version"

The above command uses data like this:

{
  "input":{
    "first":{
      "implementations":{
        "implementation":[
          {
            "vendor":"cisco",
            "software-version":"6.1.1",
            "platform":"asr9k-px"
          }
        ]
      }
    },
    "second":{
      "implementations":{
        "implementation":[
          {
            "vendor":"cisco",
            "software-version":"6.1.3",
            "platform":"asr9k-px"
          }
        ]
      }
    }
  }
}

The above command returns JSON-formatted output like this:

{
  "output": [
    {
      "derived-semantic-version-results": "Both modules failed compilation",
      "name": "Cisco-IOS-XR-bundlemgr-cfg",
      "new-derived-semantic-version": "2.0.0",
      "old-derived-semantic-version": "1.0.0",
      "organization": "cisco",
      "revision-new": "2016-12-16",
      "revision-old": "2016-05-12",
      "yang-module-diff": "https://yangcatalog.org/api//services/diff-file/file1=Cisco-IOS-XR-bundlemgr-cfg@2016-05-12/file2=Cisco-IOS-XR-bundlemgr-cfg@2016-12-16"
    },
    {
      "derived-semantic-version-results": "pyang --check-update-from output: https://yangcatalog.org/api//services/file1=Cisco-IOS-XR-snmp-test-trap-act@2016-10-25/check-update-from/file2=Cisco-IOS-XR-snmp-test-trap-act@2016-04-17",
      "name": "Cisco-IOS-XR-snmp-test-trap-act",
      "new-derived-semantic-version": "2.0.0",
      "old-derived-semantic-version": "1.0.0",
      "organization": "cisco",
      "revision-new": "2016-10-25",
      "revision-old": "2016-04-17",
      "yang-module-diff": "https://yangcatalog.org/api//services/diff-file/file1=Cisco-IOS-XR-snmp-test-trap-act@2016-04-17/file2=Cisco-IOS-XR-snmp-test-trap-act@2016-10-25",
      "yang-module-pyang-tree-diff": "https://yangcatalog.org/api//services/diff-tree/file1=Cisco-IOS-XR-snmp-test-trap-act@2016-04-17/file2=Cisco-IOS-XR-snmp-test-trap-act@2016-10-25"    },
    {
      "derived-semantic-version-results": "Both modules failed compilation",
      "name": "Cisco-IOS-XR-qos-ma-oper",
    .
    .
    .

This endpoint serves to get output from the pyang tool with the option --check-update-from for all the modules between the "old" and the "new" filter. If module compilation failed it will only give you the link to get the diff of the two yang modules. if check-update-from has an output it will provide a tree diff and output of the pyang together with the diff of the two files

HTTP Request

POST https://yangcatalog.org/api/check-semantic-version

Body Parameters

Inside of the body we need to start with an "input" container which needs to contain the containers "old" and "new" to which we provide all the leafs with data that needs to be filtered out of yangcatalog. All the leafs can be found in draft-clacla-netmod-model-catalog-03 section 2-2

Get file difference

import requests

url = 'https://yangcatalog.org/api/services/diff-file/file1=<f1>@<r1>/file2=<f2>@<r2>'
requests.get(url, headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" -H "Content-type: application/json"
 "https://yangcatalog.org/api/services/diff-file/file1=<f1>@<r1>/file2=<f2>@<r2>"

The above command returns HTML-formatted error messages like this:

<html><body>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- Generated by rfcdiff 1.47: rfcdiff  -->
<!-- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional" > -->
<!-- System: Linux ietfa 4.4.143-65-default #1 SMP Tue Aug 14 09:18:29 UTC 2018 (4e090cc) x86_64 x86_64 x86_64 GNU/Linux -->
<!-- Using awk: /usr/bin/gawk: GNU Awk 4.1.3, API: 1.1 -->
<!-- Using diff: /usr/bin/diff: diff (GNU diffutils) 3.3 -->
<!-- Using wdiff: /usr/bin/wdiff: wdiff (GNU wdiff) 1.2.2 -->
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
  <meta http-equiv="Content-Style-Type" content="text/css" />
  <title>Diff: schema1.txt - schema2.txt</title>
  <style type="text/css">
    body    { margin: 0.4ex; margin-right: auto; }
    tr      { }
    .
    .
    .

This endpoint serves to get diff of the two yang modules

HTTP Request

GET https://yangcatalog.org/api/services/diff-file/file1=<f1>@<r1>/file2=<f2>@<r2>

URL Parameters

Parameter Description
f1 Name of the first module
r1 Revision of the first module
f2 Name of the second module
r2 Revision of the second module

Get tree difference

import requests

url = 'https://yangcatalog.org/api/services/diff-tree/file1=<f1>@<r1>/file2=<f2>@<r2>'
requests.get(url, headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" -H "Content-type: application/json"
 "https://yangcatalog.org/api/services/diff-tree/file1=<f1>@<r1>/file2=<f2>@<r2>"

The above command returns HTML-formatted error messages like this:

<html><body>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- Generated by rfcdiff 1.47: rfcdiff  -->
<!-- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional" > -->
<!-- System: Linux ietfa 4.4.143-65-default #1 SMP Tue Aug 14 09:18:29 UTC 2018 (4e090cc) x86_64 x86_64 x86_64 GNU/Linux -->
<!-- Using awk: /usr/bin/gawk: GNU Awk 4.1.3, API: 1.1 -->
<!-- Using diff: /usr/bin/diff: diff (GNU diffutils) 3.3 -->
<!-- Using wdiff: /usr/bin/wdiff: wdiff (GNU wdiff) 1.2.2 -->
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
  <meta http-equiv="Content-Style-Type" content="text/css" />
  <title>Diff: schema1.txt - schema2.txt</title>
  <style type="text/css">
    body    { margin: 0.4ex; margin-right: auto; }
    tr      { }
    .
    .
    .

This endpoint serves to get tree diff of the two yang modules

HTTP Request

GET https://yangcatalog.org/api/services/diff-tree/file1=<f1>@<r1>/file2=<f2>@<r2>

URL Parameters

Parameter Description
f1 Name of the first module
r1 Revision of the first module
f2 Name of the second module
r2 Revision of the second module

Get update difference

import requests

url = 'https://yangcatalog.org/api/services/file1=<f1>@<r1>/check-update-from/file2=<f2>@<r2>'
requests.get(url, headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" -H "Content-type: application/json"
 "https://yangcatalog.org/api/services/file1=<f1>@<r1>/check-update-from/file2=<f2>@<r2>"

The above command returns HTML-formatted error messages like this:

<html><body><pre>/home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-10-25.yang:289: error: the mandatory 'true' is illegally added
/home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-10-25.yang:308: error: the mandatory 'true' is illegally added
/home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-10-25.yang:314: error: the leaf 'address', defined at /home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-04-17.yang:305 is illegally removed
/home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-10-25.yang:314: error: the leaf 'ifindex', defined at /home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-04-17.yang:310 is illegally removed
/home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-10-25.yang:339: error: the leaf 'entity-id', defined at /home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-04-17.yang:325 is illegally removed
/home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-10-25.yang:339: error: the leaf 'entity-index', defined at /home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-04-17.yang:333 is illegally removed
/home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-10-25.yang:339: error: the leaf 'peer-id', defined at /home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-04-17.yang:340 is illegally removed
/home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-10-25.yang:377: error: the leaf 'index', defined at /home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-04-17.yang:355 is illegally removed
/home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-10-25.yang:377: error: the leaf 'instance', defined at /home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-04-17.yang:362 is illegally removed
/home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-10-25.yang:377: error: the leaf 'source', defined at /home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-04-17.yang:369 is illegally removed
/home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-10-25.yang:377: error: the leaf 'destination', defined at /home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-04-17.yang:374 is illegally removed
/home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-10-25.yang:416: error: the leaf 'index', defined at /home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-04-17.yang:385 is illegally removed
/home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-10-25.yang:416: error: the leaf 'instance', defined at /home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-04-17.yang:392 is illegally removed
/home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-10-25.yang:416: error: the leaf 'source', defined at /home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-04-17.yang:399 is illegally removed
/home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-10-25.yang:416: error: the leaf 'destination', defined at /home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-04-17.yang:404 is illegally removed
/home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-10-25.yang:456: error: the leaf 'index', defined at /home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-04-17.yang:416 is illegally removed
/home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-10-25.yang:456: error: the leaf 'instance', defined at /home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-04-17.yang:423 is illegally removed
/home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-10-25.yang:456: error: the leaf 'source', defined at /home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-04-17.yang:430 is illegally removed
/home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-10-25.yang:456: error: the leaf 'destination', defined at /home/miroslav/cache/backup_files/Cisco-IOS-XR-snmp-test-trap-act@2016-04-17.yang:434 is illegally removed
</pre></body></html>

This endpoint serves to get the output from the pyang tool with the option --check-update-from between two modules provided in the path of the request

HTTP Request

GET https://yangcatalog.org/api/services/file1=<f1>@<r1>/check-update-from/file2=<f2>@<r2>

URL Parameters

Parameter Description
f1 Name of the first module
r1 Revision of the first module
f2 Name of the second module
r2 Revision of the second module

Get single leaf data

import requests

body = <data>
url = 'https://yangcatalog.org/api/search-filter/<leaf>'
requests.post(url, body, headers={'Accept': 'application/json'})

curl -X POST -H "Accept: application/json" -H "Content-type: application/json"
 --data '<data>'
 "https://yangcatalog.org/api/search-filter/<leaf>"

The above command uses data like this:

{
  "input":{
    "implementations":{
      "implementation":[
        {
          "vendor":"cisco",
          "software-version":"6.4.1"
        }
      ]
    }
  }
}

The above command returns JSON-formatted output like this:

{
  "output": {
    "author-email": [
      "draft-openconfig-netmod-model-catalog@ietf.org"
    ]
  }
}

This endpoint serves to get a list of leafs specified by <leaf> from a filtered set of modules. The filter is specified in the body of the request

HTTP Request

POST https://yangcatalog.org/api/search-filter/<leaf>

Body Parameters

Inside of the body we need to start with "input" to which we provide all the leafs with data that need to be filtered out of yangcatalog. All the leafs can be found in draft-clacla-netmod-model-catalog-03 section 2-2 In this request there an option that can be inserted called "recursive". If set to true it will look for all dependencies of the module and search for <leaf> data in those too.

Get raw module

import requests

url = 'https://yangcatalog.org/api/services/reference/<f1>@<r1>.yang'
requests.get(url, headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" -H "Content-type: application/json"
 "https://yangcatalog.org/api/services/reference/<f1>@<r1>.yang"

The above command returns HTML-formatted raw module like this:

<html>

<body>
    <pre>module ietf-mpls {
  yang-version 1.1;
  namespace "urn:ietf:params:xml:ns:yang:ietf-mpls";

  /* Replace with IANA when assigned */

  prefix mpls;

  import ietf-routing {
    prefix rt;
    reference
      "RFC8349: A YANG Data Model for Routing Management";
  }
  import ietf-routing-types {
    prefix rt-types;
    reference
      "RFC8294:Common YANG Data Types for the Routing Area";
  }
  import ietf-yang-types {
    prefix yang;
    reference
      "RFC6991: Common YANG Data Types";
  }
  import ietf-interfaces {
    prefix if;
    reference
      "RFC8343: A YANG Data Model for Interface Management";
  }

  organization
    "IETF MPLS Working Group";
  contact
    "WG Web:   <http://tools.ietf.org/wg/mpls/>
.
.
.

This endpoint serves to get a raw yang module in html form

HTTP Request

GET https://yangcatalog.org/api/services/reference/<f1>@<r1>.yang

URL Parameters

Parameter Description
f1 Name of the first module
r1 Revision of the first module

Internal

Trigger ietf pull

import requests

url = 'https://yangcatalog.org/api/ietf'
requests.get(url, auth=('admin', 'admin'), headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" -H "Content-type: application/json"
 --user admin:admin "https://yangcatalog.org/api/ietf"

Make sure to replace admin admin with your name and password.

The above command should trigger automatic ietf pull of all new yang modules

This endpoint serves to run two different processes:

  1. pull_local.py

This script serves as an automated tool to parse and populate all the new openconfig yang modules and ietf DRAFT and RFC yang modules to yangcatalog. Since this job takes some time the endpoint will respond only with verification information and a job-id on which you can track the job status.

HTTP Request

GET https://yangcatalog.org/api/ietf

New vendor modules added

This endpoint is used within github. Whenever something is merged to the YangModels/yang github repository this endpoint is triggered and checks if there is an updated platform-metadata.json file which is then used within the populate.py script.

HTTP Request

POST https://yangcatalog.org/api/check-platform-metadata

Impact analysis tool

This endpoint is used by the impact analysis tool, which looks for relations between the various modules - dependents or dependencies. The result is an analysis of the impacts of the module with respect to other modules. The arguments are a payload specifying search options and filters.

HTTP Request

POST https://yangcatalog.org/api/yang-search/v2/impact-analysis

Load api cache

import requests

url = 'https://yangcatalog.org/api/load-cache'
requests.post(url, auth=('admin', 'admin'), headers={'Accept': 'application/json'})

curl -X POST -H "Accept: application/json" -H "Content-type: application/json"
 --user admin:admin "https://yangcatalog.org/api/load-cache"

Make sure to replace admin admin with your name and password.

The above command should trigger loading a cache api not blocking an api

This endpoint serves to reload api cached modules after new modules have been added to the yangcatalog. This should be non-blocking code. There are two caches created which should be identical and one of them should always be available for the users

HTTP Request

GET https://yangcatalog.org/api/load-cache

Get Contributors

import requests

url = 'https://yangcatalog.org/api/contributors'
requests.get(url, headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" -H "Content-type: application/json"
 "https://yangcatalog.org/api/contributors"

The above command should return all organizations that contributed with yang modules to yangcatalog

This endpoint serves to list all the organizations that contributed to yangcatalog with yang modules

HTTP Request

GET https://yangcatalog.org/api/contributors

ADMIN

The following endpoints are only for the admin UI and you need to be signed in to an ietf account using single sign on to be able to use any of the following endpoints. Once signed in and a token is aquired you will be able to create these requests.

The admin UI serves to authorized IETF personel only who have access to manage users, read through log files, and all the yangcatalog files which can be deleted, updated or read by them.

Login

import requests

url = 'https://yangcatalog.org/api/admin/login'
requests.get(url, headers={'Accept': 'application/json'})

or

import requests

url = 'https://yangcatalog.org/api/admin'
requests.get(url, headers={'Accept': 'application/json'})

or

import requests

url = 'https://yangcatalog.org/admin/login'
requests.get(url, headers={'Accept': 'application/json'})


curl -X GET -H "Accept: application/json" -H "Content-type: application/json"
 "https://yangcatalog.org/api/admin/login"

or

curl -X GET -H "Accept: application/json" -H "Content-type: application/json"
 "https://yangcatalog.org/api/admin"

or

curl -X GET -H "Accept: application/json" -H "Content-type: application/json"
 "https://yangcatalog.org/admin/login"

The above command should redirect you to the datatracker login page

This endpoint serves to make a SSO to ietf which will let you access all the admin endpoints. This endpoint will redirect you to the datatracker.ietf.org login page which after successful login will redirect you back to the yangcatalog UI healthcheck page.

HTTP Request

GET https://yangcatalog.org/api/admin/login

GET https://yangcatalog.org/api/admin

GET https://yangcatalog.org/admin/login

Logout

import requests

url = 'https://yangcatalog.org/api/admin/logout'
requests.get(url, headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" -H "Content-type: application/json"
 "https://yangcatalog.org/api/admin/logout"

The above command should remove all the remebered tokens and sessions from OIDC

This endpoint serves to log users out

HTTP Request

GET https://yangcatalog.org/api/admin/logout

Ping redirection

import requests

url = 'https://yangcatalog.org/api/admin/ping'
requests.get(url, headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" -H "Content-type: application/json"
 "https://yangcatalog.org/api/admin/ping"

The above command should not be used and is for the ietf datatracker to redirect here once a user has successfully signed in

This endpoint serves to comunicate with the ietf datatracker as a redirection link for OIDC

HTTP Request

GET https://yangcatalog.org/api/admin/ping

Admin check

import requests

url = 'https://yangcatalog.org/api/admin/check'
requests.get(url, headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" -H "Content-type: application/json"
 "https://yangcatalog.org/api/admin/check"

The above command should return following json

{
  "info": "Success"
}

This endpoint serves for the admin UI to check if the user is logged in. If he receives 200 all is ok, otherwise the user is not logged in and should be able to get into the admin UI

HTTP Request

GET https://yangcatalog.org/api/admin/check

Get file content

import requests

url = 'https://yangcatalog.org/api/admin/directory-structure/read/<path:direc>'
requests.get(url, headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" "https://yangcatalog.org/api/admin/directory-structure/read/<path:direc>"

The above command returns JSON-formatted output

{
    "data":"output of the specified file",
    "info":"Success"
}

This endpoint serves to get the content of the file specified from the /var/yang folder. This is used with the admin UI.

HTTP Request

GET https://yangcatalog.org/api/admin/directory-structure/read/<path:direc>

URL Parameters

Parameter Description
path:direc path to the file we want to read from /var/yang folder

Delete file from directory

import requests

url = 'https://yangcatalog.org/api/admin/directory-structure/<path:direc>'
requests.delete(url, headers={'Accept': 'application/json'})

curl -X DELETE -H "Accept: application/json" "https://yangcatalog.org/api/admin/directory-structure/<path:direc>"

The above command returns JSON-formatted output

{
    "data":"output of the file that has been deleted",
    "info":"Success"
}

This endpoint serves to delete a file from the /var/yang folder. This is used with the admin UI.

HTTP Request

DELETE https://yangcatalog.org/api/admin/directory-structure/<path:direc>

URL Parameters

Parameter Description
path:direc path to the file we want to delete - from /var/yang folder. This can be empty

Update file from directory

import requests

url = 'https://yangcatalog.org/api/admin/directory-structure/<path:direc>'
body = <data>
requests.put(url, body,
    headers={'Accept': 'application/json', 'Content-type': 'application/json'})

curl -X PUT -H "Accept: application/json" -H "Content-type: application/json"
 "https://yangcatalog.org/api/admin/directory-structure/<path:direc>"
 --data '<data>'

The above command uses data like this:

{
  "input": {
    "data": "Updated text for given file"
  }
}

The above command returns JSON-formatted output

{
  "data":"output of the file that has been updated",
  "info":"Success"
}

This endpoint serves to update a file from the /var/yang folder. This is used with the admin UI.

HTTP Request

PUT https://yangcatalog.org/api/admin/directory-structure/<path:direc>

URL Parameters

Parameter Description
path:direc path to the file we want to update - from /var/yang folder.

Get directory structure

import requests

url = 'https://yangcatalog.org/api/admin/directory-structure/<path:direc>'
requests.get(url, headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" "https://yangcatalog.org/api/admin/directory-structure/<path:direc>"

The above command returns JSON-formatted directory structure

{
  "data": {
    "files": [
      {
        "group": "yang",
        "name": "yang2_repo_cache.dat",
        "permissions": "0o644",
        "size": 0,
        "user": "yang"
      }
    ],
    "folders": [
      {
        "group": "yang",
        "name": "ytrees",
        "permissions": "0o775",
        "size": 43524699772,
        "user": "yang"
      },
      {
        "group": "yang",
        "name": "commit_dir",
        "permissions": "0o755",
        "size": 41,
        "user": "yang"
      }
    ],
    "name": ""
  },
  "info": "Success"
}

This endpoint serves to receive a list of files and folders on a given path with their name, group id, user id size and permissions. This is used in the admin UI

HTTP Request

GET https://yangcatalog.org/api/admin/directory-structure/<path:direc>

URL Parameters

Parameter Description
path:direc path to the file we want to read from the /var/yang folder. This can be empty

Ouptut Parameters

Each file and folder contains following data

Parameter Description
group linux group name that this file or folder belongs to
name name of the file or folder
permissions permissions of the file or folder
size size of the file or folder
user linux user name that this file or folder belongs to

List nginx files

import requests

url = 'https://yangcatalog.org/api/admin/yangcatalog-nginx'
requests.get(url, headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" "https://yangcatalog.org/api/admin/yangcatalog-nginx"

The above command returns JSON-formatted output

{
  "data": [
    "list of",
    "nginx files"
  ],
  "info":"Success"
}

This endpoint serves to receive a list of used nginx files. This is used with thr admin UI.

HTTP Request

GET https://yangcatalog.org/api/admin/yangcatalog-nginx

Read nginx file

import requests

url = 'https://yangcatalog.org/api/admin/yangcatalog-nginx/<path:nginx_file>'
requests.get(url, headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" "https://yangcatalog.org/api/admin/yangcatalog-nginx/<path:nginx_file>"

The above command returns JSON-formatted output

{
  "data": "nginx file output",
  "info":"Success"
}

This endpoint serves to read a nginx file. This is used with the admin UI.

HTTP Request

GET https://yangcatalog.org/api/admin/yangcatalog-nginx/<path:nginx_file>

URL Parameters

Parameter Description
path:nginx_file path to the nginx file we want to read

Read yangcatalog config file

import requests

url = 'https://yangcatalog.org/api/admin/yangcatalog-config'
requests.get(url, headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" "https://yangcatalog.org/api/admin/yangcatalog-config"

The above command returns JSON-formatted output

{
  "data": "yangcatalog config file output",
  "info":"Success"
}

This endpoint serves to read a yangcatalog config file. This is used with the admin UI.

HTTP Request

GET https://yangcatalog.org/api/admin/yangcatalog-config

Update yangcatalog config file

import requests

url = 'https://yangcatalog.org/api/admin/yangcatalog-config'
body = <data>
requests.put(url, body,
    headers={'Accept': 'application/json', 'Content-type': 'application/json'})

curl -X PUT -H "Accept: application/json" -H "Content-type: application/json"
 "https://yangcatalog.org/api/admin/yangcatalog-config"
 --data '<data>'

The above command uses data like this:

{
  "input": {
     "data": "Updated text for yangcatalog config file"
  }
}

The above command returns JSON-formatted output

{
  "new-data":"output of the yangcatalog config file that has been updated",
  "info":"Success"
}

This endpoint serves to update the yangcatalog config file. This is used with the admin UI.

HTTP Request

PUT https://yangcatalog.org/api/admin/yangcatalog-config

List all log files

import requests

url = 'https://yangcatalog.org/api/admin/logs'
requests.get(url, headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" "https://yangcatalog.org/api/admin/logs"

The above command returns JSON-formatted output

{
  "data": [
    "opensearch/gc",
    "crons-log",
    "confd/browser",
    "YANGgenericstats-daily",
    "confd/netconf",
    "opensearch/opensearch_index_indexing_slowlog",
    "healthcheck"
  ],
  "info": "success"
}

This endpoint serves to list all the log files we have in yangcatalog.org. This is used with the admin UI.

HTTP Request

GET https://yangcatalog.org/api/admin/logs

Search and filter for specific output in log files

import requests

url = 'https://yangcatalog.org/api/admin/logs'
body = <data>
requests.post(url, body,
    headers={'Accept': 'application/json', 'Content-type': 'application/json'})

curl -X POST -H "Accept: application/json" -H "Content-type: application/json"
 "https://yangcatalog.org/api/admin/logs"
 --data '<data>'

The above command uses data like this:

{
  "input": {
    "file-names": "yang",
    "lines-per-page": 1000,
    "page": 1,
    "from-date": null,
    "to-date": null,
    "filter": {
      "filter-out": "pika",
      "match-cases": false,
      "match-words": false,
      "search-for": "",
      "level": "INFO"
    }
  }
}

The above command returns JSON-formatted output

{
  "meta": {
    "file-names": ["list of", "log files"],
    "from-date": "timestamp same as from request",
    "to-data": "timestamp same as from request",
    "lines--per-page": 1000,
    "page": 1,
    "pages": 72,
    "filter": "same object as from request",
    "format": true
  },
  "output": "Ouptut text from log files"
}

This endpoint serves to read and filter log files. This is used with the admin UI.

HTTP Request

POST https://yangcatalog.org/api/admin/logs

Approve user

import requests

url = 'https://yangcatalog.org/api/admin/move-user'
body = <data>
requests.post(url, body,
    headers={'Accept': 'application/json', 'Content-type': 'application/json'})

curl -X POST -H "Accept: application/json" -H "Content-type: application/json"
 "https://yangcatalog.org/api/admin/move-user"
 --data '<data>'

The above command uses data like this:

{
  "input": {
    "id": "1",
    "access-rights-sdo": "ietf",
    "access-rights-vendor": "cisco"
  }
}

The above command returns JSON-formatted output like this if successful

{
  "info": "user successfully approved",
  "data": {
    "id": "1",
    "access-rights-sdo": "ietf",
    "access-rights-vendor": "cisco"
  }
}

This endpoint serves to approve a yangcatalog user and set his rights so he can add or remove modules based on the 'access-rights-sdo' and 'access-rights-vendor'. This is used with the admin UI.

HTTP Request

POST https://yangcatalog.org/api/admin/move-user

Add user

import requests

url = 'https://yangcatalog.org/api/admin/users/<status>'
body = <data>
requests.post(url, body,
    headers={'Accept': 'application/json', 'Content-type': 'application/json'})

curl -X POST -H "Accept: application/json" -H "Content-type: application/json"
 "https://yangcatalog.org/api/admin/users/<status>"
 --data '<data>'

The above command uses data like this:

{
  "input": {
    "models-provider": "Cisco Systems, Inc",
    "access-rights-sdo": "ietf",
    "access-rights-vendor": "cisco",
    "username": "foo-bar",
    "first-name": "bar",
    "last-name":"foo",
    "email": "foo-bar@bar.com",
    "password": "something secret"
  }
}

The above command returns JSON-formatted output like this if successful

{
  "info": "data successfully added to database",
  "data": {
    "models-provider": "Cisco Systems, Inc",
    "access-rights-sdo": "ietf",
    "access-rights-vendor": "cisco",
    "username": "foo-bar",
    "first-name": "bar",
    "last-name":"foo",
    "email": "foo-bar@bar.com",
    "password": "something secret"
  },
  "id": "1"
}

This endpoint serves to add a new user to the database. This is used with the admin UI.

HTTP Request

POST https://yangcatalog.org/api/admin/users/<status>

URL Parameters

Parameter Description
status Status of the user to be added, either temp or approved

Delete user

import requests

url = 'https://yangcatalog.org/api/admin/users/<status>/id/<id>'
requests.delete(url, headers={'Accept': 'application/json'})

curl -X DELETE -H "Accept: application/json"
 "https://yangcatalog.org/api/admin/users/<status>/id/<id>"

This endpoint serves to remove a user from the database. This is used with the admin UI.

HTTP Request

DELETE https://yangcatalog.org/api/admin/users/<status>/id/<id>

URL Parameters

Parameter Description
status Status of the user to be added, either temp or approved
id Id of the user you are deleting

List all users with the specified status

import requests

url = 'https://yangcatalog.org/api/admin/users/<status>'
requests.get(url, headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" "https://yangcatalog.org/api/admin/users/<status>"

The above command returns JSON-formatted output

[
  {
    "access-rights-sdo":"bbf",
    "access-rights-vendor":"",
    "email":"fooo@broadband-forum.org",
    "first-name":"fooo",
    "id":"4",
    "last-name":"bar",
    "models-provider":"Broadband Forum",
    "username":"fooo-bar"
  },
  {
    "access-rights-sdo":"huawei",
    "access-rights-vendor":"huawei",
    "email":"fooo2@huawei.com",
    "first-name":"fooo2",
    "id":"5",
    "last-name":"bar",
    "models-provider":"Huawei Tech.",
    "username":"fooo-bar2"
  }
  .
  .
  .

This endpoint serves to list all the users with the specified status that exists in yangcatalog.org. This is used with the admin UI.

HTTP Request

GET https://yangcatalog.org/api/admin/users/<status>

URL Parameters

Parameter Description
status Status of the user to be added, either temp or approved

Get list of all scripts

import requests

url = 'https://yangcatalog.org/api/admin/scripts'
requests.get(url, headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" "https://yangcatalog.org/api/admin/scripts"

The above command returns JSON-formatted output like this

{
  "data":[
    "populate",
    "runCapabilities",
    "ietf_push",
    "iana_push",
    "pull_local",
    "statistics",
    "recovery",
    "opensearch_recovery",
    "opensearch_fill",
    "resolve_expiration",
    "reviseSemver"
  ],
  "info":"Success"
}

This endpoint serves to receive a list of scripts that are available to use. This is used with the admin UI.

HTTP Request

GET https://yangcatalog.org/api/admin/scripts

Get script details

import requests

url = 'https://yangcatalog.org/api/admin/scripts/<script>'
requests.get(url, headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" "https://yangcatalog.org/api/admin/scripts/<script>"

The above command returns JSON-formatted output like this for populate script

{
  "data": {
    "api": {
      "default": false,
      "type": "bool"
    },
    "dir": {
      "default": "/var/yang/nonietf/yangmodels/yang/standard/ietf/RFC",
      "type": "str"
    },
    "force_indexing": {
      "default": false,
      "type": "bool"
    },
    "force_parsing": {
      "default": false,
      "type": "bool"
    },
    "notify_indexing": {
      "default": false,
      "type": "bool"
    },
    "result_html_dir": {
      "default": "/usr/share/nginx/html/results",
      "type": "str"
    },
    "save_file_dir": {
      "default": "/var/yang/all_modules",
      "type": "str"
    },
    "sdo": {
      "default": false,
      "type": "bool"
    }
  },
  "help": "Parse hello messages and YANG files to a JSON dictionary. These dictionaries are used for populating the yangcatalog. This script first runs the runCapabilities.py script to create JSON files which are used to populate database.",
  "options": {
    "api": "If request came from api",
    "credentials": "Set authorization parameters username and password respectively.",
    "dir": "Set directory where to look for hello message xml files",
    "force_indexing": "Force indexing files (do not skip indexing for unchanged files).",
    "force_parsing": "Force parse files (do not skip parsing for unchanged files).",
    "notify_indexing": "Whether to send files for indexing",
    "result_html_dir": "Set dir where to write HTML compilation result files. Default: /usr/share/nginx/html/results",
    "save_file_dir": "Directory where the yang file will be saved. Default: /var/yang/all_modules",
    "sdo": "If we are processing sdo or vendor yang modules"
  }
}

This endpoint serves to receive details about the script you are running. It will show you what options you can use with its default values and help if it contains any. This is used with the admin UI.

HTTP Request

GET https://yangcatalog.org/api/admin/scripts/<script>

URL Parameters

Parameter Description
script Name of the script you want to use

Run script

import requests

url = 'https://yangcatalog.org/api/admin/scripts/<script>'
body = <data>
requests.post(url, body,
    headers={'Accept': 'application/json', 'Content-type': 'application/json'})

curl -X POST -H "Accept: application/json" -H "Content-type: application/json"
 "https://yangcatalog.org/api/admin/scripts/<script>"
 --data '<data>'

The above command uses data like this if the script is "draft_push":

{
    "input":{
        "config_path":"/etc/yangcatalog/yangcatalog.conf",
        "send_message":false
    }
}

The above command returns JSON-formatted output like this if successful

{
    "info": "Verification successful",
    "job_id": "sadfaewsf-sdfas4568-ef5s8df-as4568ef",
    "arguments": ["list of", "arguments sent"]
}

This endpoint serves to run scripts manualy from yangcatalog.org. We need to provide a payload with arguments for a given script where key is a name of the option and value is a value you want to provide to that specific option of the script. This is used with the admin UI.

HTTP Request

POST https://yangcatalog.org/api/admin/scripts/<script>

URL Parameters

Parameter Description
script Name of the script you want to run

Get script details

import requests

url = 'https://yangcatalog.org/api/admin/disk-usage'
requests.get(url, headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" "https://yangcatalog.org/api/admin/disk-usage"

The above command returns JSON-formatted output like this

{
  "data":{
    "free": 205436604416,
    "total": 416291377152,
    "used": 210837995520
  },
  "info":"Success"
}

This endpoint serves to receive disk space information in bytes. This is used with the admin UI.

HTTP Request

GET https://yangcatalog.org/api/admin/disk-usage

URL Parameters

Parameter Description
script Name of the script you want to use

Healthchecks

The following enpoints serve to check the health status of yangcatalog.org. AWS where yangcatalog.org is running checks the following endpoints from several locations every minute several times. When any of the healthchecks fails it sends the message to a preset mailing list and informs about this failure. If the failure is on the backend API itself, all of the healthcheck endpoints will consequently fail even if it is a false failure. These endpoints are used within the admin UI as well.

Get list of services

import requests

url = 'https://yangcatalog.org/api/admin/healthcheck/services-list'
requests.get(url, headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" -H "Content-type: application/json"
 "https://yangcatalog.org/api/admin/healthcheck/services-list"

The above command should return services with their endpoints for healthchecks (just the last part) we need to use https://yangcatalog.org/api/admin/healthcheck/ in front of all of them

[
  {
    "endpoint": "opensearch",
    "name": "OpenSearch"
  },
  {
    "endpoint": "confd",
    "name": "ConfD"
  },
  {
    "endpoint": "yang-search-admin",
    "name": "YANG search"
  },
  {
    "endpoint": "yang-validator-admin",
    "name": "YANG validator"
  },
  {
    "endpoint": "yangre-admin",
    "name": "YANGre"
  },
  {
    "endpoint": "nginx",
    "name": "NGINX"
  },
  {
    "endpoint": "celery",
    "name": "Celery"
  }
]

This endpoint serves to provide with all the services we have with endpoints to check their healthstatus

HTTP Request

GET https://yangcatalog.org/api/admin/healthcheck/services-list

Get service healthcheck

import requests

url = 'https://yangcatalog.org/api/admin/healthcheck/<service-name>'
requests.get(url, headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" -H "Content-type: application/json"
 "https://yangcatalog.org/api/admin/healthcheck/<service-name>"

The above command should return the service health status (example output with ConfD)

{
  "info": "ConfD is running",
  "message": "yang-catalog,2018-04-03,ietf successfully loaded from ConfD",
  "status": "running"
}

This endpoint serves to provide the service health status

HTTP Request

GET https://yangcatalog.org/api/admin/healthcheck/<service-name>

URL Parameters

Parameter Description
service-name Name of the service you want to test health for

Output Parameters

Parameter Description
info status information
message short description of status (why it failed or why are we saying it is running)
status status enum - can be 'running', 'failed' or 'problem'

Get service admin healthcheck

import requests

url = 'https://yangcatalog.org/api/admin/healthcheck/<service-name>-admin'
requests.get(url, headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" -H "Content-type: application/json"
 "https://yangcatalog.org/api/admin/healthcheck/<service-name>-admin"

The above command should return the service admin health status (example output with yangre-admin)

{
  "info": "yangre is available",
  "message": "yangre successfully validated string",
  "status": "running"
}

This endpoint serves to provide the service admin health status. This is valid only for yang-validator-admin, yangre-admin and yang-search-admin. These endpoints are not checking only if the service itself is running (django or flask application with uwsgi), but also trying to make requests on some real data and checking if they are getting valid responses.

HTTP Request

GET https://yangcatalog.org/api/admin/healthcheck/<service-name>-admin

URL Parameters

Parameter Description
service-name Name of the service you want to test health for. It can be yang-validator, yanre or yang-search

Output Parameters

Parameter Description
info status information
message short description of status (why it failed or why are we saying it is running)
status status enum - can be 'running', 'failed' or 'problem'

Get cronjobs healthcheck

import requests

url = 'https://yangcatalog.org/api/admin/healthcheck/cronjobs'
requests.get(url, headers={'Accept': 'application/json'})

curl -X GET -H "Accept: application/json" -H "Content-type: application/json"
 "https://yangcatalog.org/api/admin/healthcheck/cronjobs"

The above command should return data about each cronjob

{
  "data": {
    "ietf_push": {
      "end": 1599603601,
      "error": "",
      "last_successfull": 1599603601,
      "start": 1599603558,
      "status": "Success"
    },
    "iana_push": {
      "end": 1599603601,
      "error": "",
      "last_successfull": 1599603601,
      "start": 1599603558,
      "status": "Success"
    },
    "pull_local": {
      "end": 1599612283,
      "error": "",
      "last_successfull": 1599612283,
      "start": 1599602701,
      "status": "Success"
    },
    "recovery": {
      "end": 1599589314,
      "error": "",
      "last_successfull": 1599589314,
      "start": 1599589021,
      "status": "Success"
    },
    "remove_unused": {
      "end": 1599579002,
      "error": "AuthenticationException(401, '{\"Message\":\"settings.role_arn is needed for snapshot registration.\"}')",
      "start": 1599579002,
      "status": "Fail"
    },
    "resolve_expiration": {
      "end": 1599625957,
      "error": "",
      "last_successfull": 1599625957,
      "start": 1599624301,
      "status": "Success"
    },
    "statistics": {
      "end": 1599621220,
      "error": "",
      "last_successfull": 1599621220,
      "start": 1599620702,
      "status": "Success"
    }
  }
}

This endpoint serves to provide information about cronjobs that are running on a daily or weekly basis. each one contains information about its starting and ending timestamp, status if it failed or run successfully, error message and last successful run timestamp

HTTP Request

GET https://yangcatalog.org/api/admin/healthcheck/cronjobs

Output Parameters

each cronjob contains the following data

Parameter Description
end timestamp of last run end time
error error message if job failed
last_successfull timestamp of last successful run
start timestamp of last run start time
status status enum - can be 'Fail' or 'Success'
shell python