POST /api/smart_proxies/:id/import_puppetclasses
Import puppet classes from puppet proxy

POST /api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses
Импорт классов Puppet из прокси Puppet в окружение

POST /api/environments/:environment_id/smart_proxies/:id/import_puppetclasses
Импорт классов Puppet из прокси Puppet в окружение

Примеры

POST /api/smart_proxies/182953976/import_puppetclasses
{
  "smart_proxy": {}
}
200
{
  "message": "Successfully updated environment and puppetclasses from the on-disk puppet installation",
  "environments_with_new_puppetclasses": 2,
  "environments_updated_puppetclasses": 0,
  "environments_obsolete": 3,
  "environments_ignored": 0,
  "results": [
    {
      "name": "env1",
      "actions": [
        "new"
      ],
      "new_puppetclasses": [
        "a"
      ]
    },
    {
      "name": "env2",
      "actions": [
        "new"
      ],
      "new_puppetclasses": [
        "b"
      ]
    },
    {
      "name": "global_puppetmaster",
      "actions": [
        "obsolete"
      ],
      "removed_environment": "global_puppetmaster"
    },
    {
      "name": "production",
      "actions": [
        "obsolete"
      ],
      "removed_environment": "production"
    },
    {
      "name": "testing",
      "actions": [
        "obsolete"
      ],
      "removed_environment": "testing"
    }
  ]
}

Параметры

Имя параметра Описание
location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer

organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer

id
обязательно

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

smart_proxy_id
необязательно

Validations:

  • Must be a String

environment_id
необязательно

Validations:

  • Must be a String

dryrun
необязательно

Validations:

  • Must be one of: true, false, 1, 0.

except
необязательно

Дополнительная строка для ограничения списка импортируемых классов. Может содержать значения «new», «updated» и «obsolete», разделенные запятой

Validations:

  • Must be a String


GET /api/smart_proxies
Список всех капсул

Примеры

GET /api/smart_proxies
200
{
  "total": 8,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": "feature=TFTP",
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "created_at": "2019-09-11 14:48:32 UTC",
      "updated_at": "2019-09-11 14:48:32 UTC",
      "name": "TFTP Proxy",
      "id": 298486374,
      "url": "http://somewhere.else",
      "features": [
        {
          "capabilities": [],
          "name": "TFTP",
          "id": 303403661
        }
      ]
    }
  ]
}

Параметры

Имя параметра Описание
location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer

organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer

search
необязательно

отфильтровать результаты

Validations:

  • Must be a String

order
необязательно

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
необязательно

Номер страницы, начиная с 1

Validations:

  • Must be a number.

per_page
необязательно

Число элементов на странице

Validations:

  • Must be a number.

Search fields

Field name Тип Possible values
feature string
location string
location_id integer
name string
organization string
organization_id integer
url string

GET /api/smart_proxies/:id
Показать капсулу

Примеры

GET /api/smart_proxies/980190962-DHCP%20Proxy
200
{
  "created_at": "2019-09-11 14:48:32 UTC",
  "updated_at": "2019-09-11 14:48:32 UTC",
  "name": "DHCP Proxy",
  "id": 980190962,
  "url": "https://somewhere.net:8443",
  "features": [
    {
      "capabilities": [],
      "name": "DHCP",
      "id": 219245707
    }
  ],
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "organizations": [
    {
      "id": 447626438,
      "name": "Organization 1",
      "title": "Organization 1",
      "description": null
    }
  ]
}

Параметры

Имя параметра Описание
location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer

organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer

id
обязательно

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/smart_proxies
Создать капсулу

Примеры

POST /api/smart_proxies
{
  "smart_proxy": {
    "name": "",
    "url": "http://server:8443"
  }
}
422
{
  "error": {
    "id": null,
    "errors": {
      "name": [
        "can't be blank"
      ]
    },
    "full_messages": [
      "Name can't be blank"
    ]
  }
}

Параметры

Имя параметра Описание
location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer

organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer

smart_proxy
обязательно

Validations:

  • Must be a Hash

smart_proxy[name]
обязательно

Validations:

  • Must be a String

smart_proxy[url]
обязательно

Validations:

  • Must be a String

smart_proxy[location_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ местоположения с заданным кодом

Validations:

  • Must be an array of any type

smart_proxy[organization_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ организации с заданным кодом

Validations:

  • Must be an array of any type


PUT /api/smart_proxies/:id
Изменить капсулу

Примеры

PUT /api/smart_proxies/980190962-DHCP%20Proxy
{
  "smart_proxy": {
    "name": "master02",
    "url": "http://server:8443"
  }
}
200
{
  "created_at": "2019-09-11 14:48:32 UTC",
  "updated_at": "2019-09-11 14:48:39 UTC",
  "name": "master02",
  "id": 980190962,
  "url": "http://server:8443",
  "features": [
    {
      "capabilities": [],
      "name": "DHCP",
      "id": 219245707
    },
    {
      "capabilities": [],
      "name": "DNS",
      "id": 49142851
    },
    {
      "capabilities": [],
      "name": "TFTP",
      "id": 303403661
    },
    {
      "capabilities": [],
      "name": "DHCP",
      "id": 219245707
    },
    {
      "capabilities": [],
      "name": "Puppet CA",
      "id": 783807086
    },
    {
      "capabilities": [],
      "name": "Puppet",
      "id": 1006510553
    },
    {
      "capabilities": [],
      "name": "BMC",
      "id": 821748566
    },
    {
      "capabilities": [],
      "name": "Chef Proxy",
      "id": 848995175
    },
    {
      "capabilities": [],
      "name": "Realm",
      "id": 982965213
    },
    {
      "capabilities": [],
      "name": "Logs",
      "id": 814728799
    }
  ],
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "organizations": [
    {
      "id": 447626438,
      "name": "Organization 1",
      "title": "Organization 1",
      "description": null
    }
  ]
}

Параметры

Имя параметра Описание
location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer

organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer

id
обязательно

Validations:

  • Must be a String

smart_proxy
обязательно

Validations:

  • Must be a Hash

smart_proxy[name]
необязательно

Validations:

  • Must be a String

smart_proxy[url]
необязательно

Validations:

  • Must be a String

smart_proxy[location_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ местоположения с заданным кодом

Validations:

  • Must be an array of any type

smart_proxy[organization_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ организации с заданным кодом

Validations:

  • Must be an array of any type


DELETE /api/smart_proxies/:id
Удалить капсулу

Примеры

DELETE /api/smart_proxies/281110143-Unused%20Proxy
{
  "smart_proxy": {}
}
200
{
  "id": 281110143,
  "name": "Unused Proxy",
  "url": "http://else.where:45672",
  "created_at": "2019-09-11T14:48:32.049Z",
  "updated_at": "2019-09-11T14:48:32.049Z",
  "expired_logs": "0"
}

Параметры

Имя параметра Описание
location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer

organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer

id
обязательно

Validations:

  • Must be a String


PUT /api/smart_proxies/:id/refresh
Обновить возможности капсулы

Примеры

POST /api/smart_proxies/980190962-DHCP%20Proxy/refresh
{
  "smart_proxy": {}
}
201
{
  "created_at": "2019-09-11 14:48:32 UTC",
  "updated_at": "2019-09-11 14:48:32 UTC",
  "name": "DHCP Proxy",
  "id": 980190962,
  "url": "https://somewhere.net:8443",
  "features": [
    {
      "capabilities": [],
      "name": "DHCP",
      "id": 219245707
    },
    {
      "capabilities": [],
      "name": "DNS",
      "id": 49142851
    },
    {
      "capabilities": [],
      "name": "TFTP",
      "id": 303403661
    },
    {
      "capabilities": [],
      "name": "Puppet CA",
      "id": 783807086
    },
    {
      "capabilities": [],
      "name": "Puppet",
      "id": 1006510553
    },
    {
      "capabilities": [],
      "name": "BMC",
      "id": 821748566
    },
    {
      "capabilities": [],
      "name": "Chef Proxy",
      "id": 848995175
    },
    {
      "capabilities": [],
      "name": "Realm",
      "id": 982965213
    },
    {
      "capabilities": [],
      "name": "Logs",
      "id": 814728799
    }
  ],
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "organizations": [
    {
      "id": 447626438,
      "name": "Organization 1",
      "title": "Organization 1",
      "description": null
    }
  ]
}

Параметры

Имя параметра Описание
location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer

organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer

id
обязательно

Validations:

  • Must be a String