Chef Habitat API Documentation

Download OpenAPI specification:Download

E-mail: support@chef.io URL: https://www.chef.io/support/ License: Apache 2.0 Terms of Service

Authentication

GET_butterfly

Butterfly debug output

Responses

GET_census

Census debug output

Responses

GET_services

List information of all loaded services

Responses

Response samples

200

Content type

application/json

[{"service_group": "string",
"bldr_url": "string",
"spec_file": "string",
"spec_ident": {"origin": "string",
"name": "string",
"version": "string",
"release": 0
},
"topology": "standalone",
"update_strategy": "none",
"cfg": { },
"pkg": {"ident": "string",
"origin": "string",
"name": "string",
"version": "string",
"release": "string",
"deps": [{"origin": "string",
"name": "string",
"version": "string",
"release": 0
}
],
"env": { },
"exposes": ["string"
],
"exports": { },
"path": "string",
"svc_path": "string",
"svc_config_path": "string",
"svc_data_path": "string",
"svc_files_path": "string",
"svc_static_path": "string",
"svc_var_path": "string",
"svc_pid_file": "string",
"svc_run": "string",
"svc_user": "string",
"svc_group": "string"
},
"sys": {"version": "string",
"member_id": "string",
"ip": "string",
"hostname": "string",
"gossip_ip": "string",
"gossip_port": 0,
"http_gateway_ip": "string",
"http_gateway_port": 0,
"permanent": true
},
"health_check": "Ok",
"initialized": true,
"last_election_status": "string",
"needs_reload": true,
"needs_reconfiguration": true,
"hooks": {"health_check": {"render_pair": "string",
"stdout_log_path": "string",
"stderr_log_path": "string"
},
"init": {"render_pair": "string",
"stdout_log_path": "string",
"stderr_log_path": "string"
},
"file_updated": {"render_pair": "string",
"stdout_log_path": "string",
"stderr_log_path": "string"
},
"reload": {"render_pair": "string",
"stdout_log_path": "string",
"stderr_log_path": "string"
},
"reconfigure": {"render_pair": "string",
"stdout_log_path": "string",
"stderr_log_path": "string"
},
"suitability": {"render_pair": "string",
"stdout_log_path": "string",
"stderr_log_path": "string"
},
"run": {"render_pair": "string",
"stdout_log_path": "string",
"stderr_log_path": "string"
},
"post_run": {"render_pair": "string",
"stdout_log_path": "string",
"stderr_log_path": "string"
}
},
"config_from": "string",
"process": {"pid": 0,
"preamble": "string",
"state": "Up",
"state_entered": 0,
"started": true
}
}
]

GET_services-name-group

Show information of a single loaded service

path Parameters

name required	string
group required	string

Responses

Response samples

200

Content type

application/json

{"service_group": "string",
"bldr_url": "string",
"spec_file": "string",
"spec_ident": {"origin": "string",
"name": "string",
"version": "string",
"release": 0
},
"topology": "standalone",
"update_strategy": "none",
"cfg": { },
"pkg": {"ident": "string",
"origin": "string",
"name": "string",
"version": "string",
"release": "string",
"deps": [{"origin": "string",
"name": "string",
"version": "string",
"release": 0
}
],
"env": { },
"exposes": ["string"
],
"exports": { },
"path": "string",
"svc_path": "string",
"svc_config_path": "string",
"svc_data_path": "string",
"svc_files_path": "string",
"svc_static_path": "string",
"svc_var_path": "string",
"svc_pid_file": "string",
"svc_run": "string",
"svc_user": "string",
"svc_group": "string"
},
"sys": {"version": "string",
"member_id": "string",
"ip": "string",
"hostname": "string",
"gossip_ip": "string",
"gossip_port": 0,
"http_gateway_ip": "string",
"http_gateway_port": 0,
"permanent": true
},
"health_check": "Ok",
"initialized": true,
"last_election_status": "string",
"needs_reload": true,
"needs_reconfiguration": true,
"hooks": {"health_check": {"render_pair": "string",
"stdout_log_path": "string",
"stderr_log_path": "string"
},
"init": {"render_pair": "string",
"stdout_log_path": "string",
"stderr_log_path": "string"
},
"file_updated": {"render_pair": "string",
"stdout_log_path": "string",
"stderr_log_path": "string"
},
"reload": {"render_pair": "string",
"stdout_log_path": "string",
"stderr_log_path": "string"
},
"reconfigure": {"render_pair": "string",
"stdout_log_path": "string",
"stderr_log_path": "string"
},
"suitability": {"render_pair": "string",
"stdout_log_path": "string",
"stderr_log_path": "string"
},
"run": {"render_pair": "string",
"stdout_log_path": "string",
"stderr_log_path": "string"
},
"post_run": {"render_pair": "string",
"stdout_log_path": "string",
"stderr_log_path": "string"
}
},
"config_from": "string",
"process": {"pid": 0,
"preamble": "string",
"state": "Up",
"state_entered": 0,
"started": true
}
}

GET_services-name-group-config

Get last configuration for the given service group

path Parameters

name required	string
group required	string

Responses

GET_services-name-group-health

Health check status and output for the given service group

path Parameters

name required	string
group required	string

Responses

Response samples

200

Content type

application/json

{"stdout": "string",
"stderr": "string"
}

GET_services-name-group-organization

Show information of a single loaded service scoped to an organization

path Parameters

name required	string
group required	string
organization required	string

Responses

Response samples

200

Content type

application/json

{"service_group": "string",
"bldr_url": "string",
"spec_file": "string",
"spec_ident": {"origin": "string",
"name": "string",
"version": "string",
"release": 0
},
"topology": "standalone",
"update_strategy": "none",
"cfg": { },
"pkg": {"ident": "string",
"origin": "string",
"name": "string",
"version": "string",
"release": "string",
"deps": [{"origin": "string",
"name": "string",
"version": "string",
"release": 0
}
],
"env": { },
"exposes": ["string"
],
"exports": { },
"path": "string",
"svc_path": "string",
"svc_config_path": "string",
"svc_data_path": "string",
"svc_files_path": "string",
"svc_static_path": "string",
"svc_var_path": "string",
"svc_pid_file": "string",
"svc_run": "string",
"svc_user": "string",
"svc_group": "string"
},
"sys": {"version": "string",
"member_id": "string",
"ip": "string",
"hostname": "string",
"gossip_ip": "string",
"gossip_port": 0,
"http_gateway_ip": "string",
"http_gateway_port": 0,
"permanent": true
},
"health_check": "Ok",
"initialized": true,
"last_election_status": "string",
"needs_reload": true,
"needs_reconfiguration": true,
"hooks": {"health_check": {"render_pair": "string",
"stdout_log_path": "string",
"stderr_log_path": "string"
},
"init": {"render_pair": "string",
"stdout_log_path": "string",
"stderr_log_path": "string"
},
"file_updated": {"render_pair": "string",
"stdout_log_path": "string",
"stderr_log_path": "string"
},
"reload": {"render_pair": "string",
"stdout_log_path": "string",
"stderr_log_path": "string"
},
"reconfigure": {"render_pair": "string",
"stdout_log_path": "string",
"stderr_log_path": "string"
},
"suitability": {"render_pair": "string",
"stdout_log_path": "string",
"stderr_log_path": "string"
},
"run": {"render_pair": "string",
"stdout_log_path": "string",
"stderr_log_path": "string"
},
"post_run": {"render_pair": "string",
"stdout_log_path": "string",
"stderr_log_path": "string"
}
},
"config_from": "string",
"process": {"pid": 0,
"preamble": "string",
"state": "Up",
"state_entered": 0,
"started": true
}
}

GET_services-name-group-organization-config

Get last configuration for the given service group

path Parameters

name required	string
group required	string
organization required	string

Responses

GET_services-name-group-organization-health

Health check status and output for the given service group

path Parameters

name required	string
group required	string
organization required	string

Responses

Response samples

200

Content type

application/json

{"stdout": "string",
"stderr": "string"
}