Plugin collection

Read-only

This resource type refers to the collection of plugin items.

In other Collection+JSON resource representations this resource type is linked by any link relation with attribute:

"rel": "plugins"

GET /api/v1/plugins/

Synopsis:Gets the list of system plugins.

Example request:

GET /api/v1/plugins/ HTTP/1.1
Host: localhost:8000
Accept: application/vnd.collection+json

Example response:

HTTP/1.1 200 OK
Allow: GET
Content-Type: application/vnd.collection+json

{
    "collection": {
        "href": "https://localhost:8000/api/v1/plugins/",
        "items": [
            {
                "data": [
                    {
                        "name": "name",
                        "value": "simpledsapp"
                    },
                    {
                        "name": "type",
                        "value": "ds"
                    }
                ],
                "href": "https://localhost:8000/api/v1/plugins/13/",
                "links": [
                    {
                        "href": "https://localhost:8000/api/v1/plugins/13/parameters/",
                        "rel": "parameters"
                    },
                    {
                        "href": "https://localhost:8000/api/v1/plugins/13/instances/",
                        "rel": "instances"
                    }
                ]
            },
            {
                "data": [
                    {
                        "name": "name",
                        "value": "simplefsapp"
                    },
                    {
                        "name": "type",
                        "value": "fs"
                    }
                ],
                "href": "https://localhost:8000/api/v1/plugins/12/",
                "links": [
                    {
                        "href": "https://localhost:8000/api/v1/plugins/12/parameters/",
                        "rel": "parameters"
                    },
                    {
                        "href": "https://localhost:8000/api/v1/plugins/12/instances/",
                        "rel": "instances"
                    }
                ]
            }
        ],
        "links": [
            {
                "href": "https://localhost:8000/api/v1/",
                "rel": "feeds"
            }
        ],
        "version": "1.0"
    }
}

Request Headers:  

• Accept – application/vnd.collection+json

Response Headers:  

• Content-Type – application/vnd.collection+json

Status Codes:

• 200 OK – no error
• 401 Unauthorized – authentication credentials were not provided

Properties (API semantic descriptors):

• plugin item properties

Link Relations:

• plugin item link relations
• feeds – links to the collection of feeds for the currently authenticated user