This API call creates a config item and returns it.
HTTP-, API- or Beetil-specific errors will be returned otherwise.
- API URL
- https://youraccount.beetil.com/external_api/v1/config_items.format
- HTTP Method
- POST
POST parameters
| Parameter | Format | Default | Mandatory |
|---|---|---|---|
| name | string | Yes | |
| config_type_idSee Show Top Level Config Types. | integer | Yes | |
| owner_idSee Index Users. | integer | Yes | |
| description | string | No | |
| notify_watchlisted | boolean | No | |
| config_type_fields | hash | No | |
| additional_fields | hash | No | |
| config_relationships | hash | No |
These parameters are encapsulated into a 'config_item' parameter. See the examples below.
Points of Interest
- config_type_fields: Accepts key value pairs, where each key is the name of a config type field. Example "user_type": "developer"
- additional_fields: Accepts key value pairs, where each key is the name of a config type field. Example "expiration_date": "01-01-2014"
- config_relationships: Accepts hashes that contain the config_relationship_type_id and id of the other config item. Example: { "config_relationship_type_id": 1, "other_config_item": id": "100" }
Example POST
{
"config_item": {
"name": "foo bar baz",
"config_relationships": [
{
"config_relationship_type_id": 1,
"other_config_item_id": 100
}
],
"config_type_fields": [
{
"user_type": "developer",
"Description": "text editor license"
}
],
"notify_watchlisted": "0",
"owner_id": "359",
"config_type_id": "313",
"additional_fields": [
{
"expiration_date": "01-01-2014",
"purchase_date": "01-01-2010"
}
],
"description": "foo bar baz"
}
}Example POST Response
{
"result": {
"config_item": "JSON string similar to GET config_items/:id"
},
"version": "1.0",
"status": "Success"
}Example Error
{
"staus": "Failed",
"errors": [
{
"error": "[E400] no config type found"
}
],
"version": "1.0"
}Last updated 31 January 2011