Chef Software InfraProxy API
The InfraProxy API from Chef Software — 36 operation(s) for infraproxy.
The InfraProxy API from Chef Software — 36 operation(s) for infraproxy.
swagger: '2.0'
info:
title: external/applications/applications.proto ApplicationsService InfraProxy API
version: version not set
consumes:
- application/json
produces:
- application/json
tags:
- name: InfraProxy
paths:
/api/v0/infra/servers:
get:
operationId: InfraProxy_GetServers
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.GetServers'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
tags:
- InfraProxy
post:
operationId: InfraProxy_CreateServer
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.CreateServer'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.request.CreateServer'
tags:
- InfraProxy
/api/v0/infra/servers/server_status:
get:
operationId: InfraProxy_GetServerStatus
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.GetServerStatus'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: fqdn
description: Server FQDN.
in: query
required: false
type: string
tags:
- InfraProxy
/api/v0/infra/servers/{id}:
get:
operationId: InfraProxy_GetServer
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.GetServer'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: id
description: Chef Infra Server ID.
in: path
required: true
type: string
tags:
- InfraProxy
delete:
operationId: InfraProxy_DeleteServer
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.DeleteServer'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: id
description: Chef Infra Server ID.
in: path
required: true
type: string
tags:
- InfraProxy
put:
operationId: InfraProxy_UpdateServer
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.UpdateServer'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: id
description: Chef Infra Server ID.
in: path
required: true
type: string
- name: body
in: body
required: true
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.request.UpdateServer'
tags:
- InfraProxy
/api/v0/infra/servers/{server_id}/orgs:
get:
operationId: InfraProxy_GetOrgs
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.GetOrgs'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: server_id
description: Chef Infra Server ID.
in: path
required: true
type: string
tags:
- InfraProxy
post:
operationId: InfraProxy_CreateOrg
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.CreateOrg'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: server_id
description: Chef Infra Server ID.
in: path
required: true
type: string
- name: body
in: body
required: true
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.request.CreateOrg'
tags:
- InfraProxy
/api/v0/infra/servers/{server_id}/orgs/{id}:
get:
operationId: InfraProxy_GetOrg
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.GetOrg'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: server_id
description: Chef Infra Server ID.
in: path
required: true
type: string
- name: id
description: Chef organization ID.
in: path
required: true
type: string
tags:
- InfraProxy
delete:
operationId: InfraProxy_DeleteOrg
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.DeleteOrg'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: server_id
description: Chef Infra Server ID.
in: path
required: true
type: string
- name: id
description: Chef organization ID.
in: path
required: true
type: string
tags:
- InfraProxy
put:
operationId: InfraProxy_UpdateOrg
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.UpdateOrg'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: server_id
description: Chef Infra Server ID.
in: path
required: true
type: string
- name: id
description: Chef organization ID.
in: path
required: true
type: string
- name: body
in: body
required: true
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.request.UpdateOrg'
tags:
- InfraProxy
/api/v0/infra/servers/{server_id}/orgs/{id}/reset-key:
put:
operationId: InfraProxy_ResetOrgAdminKey
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.ResetOrgAdminKey'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: server_id
description: Chef Infra Server ID.
in: path
required: true
type: string
- name: id
description: Chef organization ID.
in: path
required: true
type: string
- name: body
in: body
required: true
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.request.ResetOrgAdminKey'
tags:
- InfraProxy
/api/v0/infra/servers/{server_id}/orgs/{org_id}/clients:
get:
operationId: InfraProxy_GetClients
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.Clients'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: server_id
description: Chef Infra Server ID.
in: path
required: true
type: string
- name: org_id
description: Chef organization ID.
in: path
required: true
type: string
- name: search_query.q
description: The search query used to identify a list of items.
in: query
required: false
type: string
- name: search_query.page
description: Starting page for the results.
in: query
required: false
type: integer
format: int32
- name: search_query.per_page
description: The number of results on each page.
in: query
required: false
type: integer
format: int32
tags:
- InfraProxy
post:
operationId: InfraProxy_CreateClient
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.CreateClient'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: server_id
description: Chef Infra Server ID.
in: path
required: true
type: string
- name: org_id
description: Chef organization ID.
in: path
required: true
type: string
- name: body
in: body
required: true
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.request.CreateClient'
tags:
- InfraProxy
/api/v0/infra/servers/{server_id}/orgs/{org_id}/clients/{name}:
get:
operationId: InfraProxy_GetClient
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.Client'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: server_id
description: Chef Infra Server ID.
in: path
required: true
type: string
- name: org_id
description: Chef organization ID.
in: path
required: true
type: string
- name: name
description: Client name.
in: path
required: true
type: string
tags:
- InfraProxy
delete:
operationId: InfraProxy_DeleteClient
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.Client'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: server_id
description: Chef Infra Server ID.
in: path
required: true
type: string
- name: org_id
description: Chef organization ID.
in: path
required: true
type: string
- name: name
description: Client name.
in: path
required: true
type: string
tags:
- InfraProxy
/api/v0/infra/servers/{server_id}/orgs/{org_id}/clients/{name}/reset:
put:
operationId: InfraProxy_ResetClientKey
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.ResetClient'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: server_id
description: Chef Infra Server ID.
in: path
required: true
type: string
- name: org_id
description: Chef organization ID.
in: path
required: true
type: string
- name: name
description: Client name.
in: path
required: true
type: string
- name: body
in: body
required: true
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.request.ClientKey'
tags:
- InfraProxy
/api/v0/infra/servers/{server_id}/orgs/{org_id}/cookbooks:
get:
operationId: InfraProxy_GetCookbooks
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.Cookbooks'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: server_id
description: ID of the Server
in: path
required: true
type: string
- name: org_id
description: ID of the Org.
in: path
required: true
type: string
tags:
- InfraProxy
/api/v0/infra/servers/{server_id}/orgs/{org_id}/cookbooks/{name}:
get:
operationId: InfraProxy_GetCookbookVersions
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.CookbookVersions'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: server_id
description: ID of the Server.
in: path
required: true
type: string
- name: org_id
description: ID of the Org.
in: path
required: true
type: string
- name: name
description: Name of the cookbook.
in: path
required: true
type: string
tags:
- InfraProxy
/api/v0/infra/servers/{server_id}/orgs/{org_id}/cookbooks/{name}/{version}:
get:
operationId: InfraProxy_GetCookbook
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.Cookbook'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: server_id
description: ID of the Server.
in: path
required: true
type: string
- name: org_id
description: ID of the Org.
in: path
required: true
type: string
- name: name
description: Name of the cookbook.
in: path
required: true
type: string
- name: version
description: Version of the cookbook.
in: path
required: true
type: string
tags:
- InfraProxy
/api/v0/infra/servers/{server_id}/orgs/{org_id}/cookbooks/{name}/{version}/file-content:
get:
operationId: InfraProxy_GetCookbookFileContent
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.CookbookFileContent'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: server_id
description: ID of the server.
in: path
required: true
type: string
- name: org_id
description: ID of the org.
in: path
required: true
type: string
- name: name
description: Name of the cookbook.
in: path
required: true
type: string
- name: version
description: Version of the cookbook.
in: path
required: true
type: string
- name: url
description: Cookbook data file URL.
in: query
required: false
type: string
tags:
- InfraProxy
/api/v0/infra/servers/{server_id}/orgs/{org_id}/data_bags:
get:
operationId: InfraProxy_GetDataBags
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.DataBags'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: server_id
description: Chef Infra Server ID.
in: path
required: true
type: string
- name: org_id
description: Chef organization ID.
in: path
required: true
type: string
tags:
- InfraProxy
post:
operationId: InfraProxy_CreateDataBag
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.CreateDataBag'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: server_id
description: Chef Infra Server ID.
in: path
required: true
type: string
- name: org_id
description: Chef organization ID.
in: path
required: true
type: string
- name: body
in: body
required: true
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.request.CreateDataBag'
tags:
- InfraProxy
/api/v0/infra/servers/{server_id}/orgs/{org_id}/data_bags/{name}:
get:
operationId: InfraProxy_GetDataBagItems
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.DataBagItems'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: server_id
description: Chef Infra Server ID.
in: path
required: true
type: string
- name: org_id
description: Chef organization ID.
in: path
required: true
type: string
- name: name
description: Data bag name.
in: path
required: true
type: string
- name: search_query.q
description: The search query used to identify a list of items.
in: query
required: false
type: string
- name: search_query.page
description: Starting page for the results.
in: query
required: false
type: integer
format: int32
- name: search_query.per_page
description: The number of results on each page.
in: query
required: false
type: integer
format: int32
tags:
- InfraProxy
delete:
operationId: InfraProxy_DeleteDataBag
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.DataBag'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: server_id
description: Chef Infra Server ID.
in: path
required: true
type: string
- name: org_id
description: Chef organization ID.
in: path
required: true
type: string
- name: name
description: Data bag name.
in: path
required: true
type: string
tags:
- InfraProxy
post:
operationId: InfraProxy_CreateDataBagItem
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.CreateDataBagItem'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: server_id
description: Chef Infra Server ID.
in: path
required: true
type: string
- name: org_id
description: Chef organization ID.
in: path
required: true
type: string
- name: name
description: Data bag name.
in: path
required: true
type: string
- name: body
in: body
required: true
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.request.CreateDataBagItem'
tags:
- InfraProxy
/api/v0/infra/servers/{server_id}/orgs/{org_id}/data_bags/{name}/{item_id}:
put:
operationId: InfraProxy_UpdateDataBagItem
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.UpdateDataBagItem'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: server_id
description: Chef Infra Server ID.
in: path
required: true
type: string
- name: org_id
description: Chef organization ID.
in: path
required: true
type: string
- name: name
description: Data bag name.
in: path
required: true
type: string
- name: item_id
description: Data bag item ID.
in: path
required: true
type: string
- name: body
in: body
required: true
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.request.UpdateDataBagItem'
tags:
- InfraProxy
/api/v0/infra/servers/{server_id}/orgs/{org_id}/data_bags/{name}/{item}:
get:
operationId: InfraProxy_GetDataBagItem
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.DataBagItem'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: server_id
description: Chef Infra Server ID.
in: path
required: true
type: string
- name: org_id
description: Chef organization ID.
in: path
required: true
type: string
- name: name
description: Data bag name.
in: path
required: true
type: string
- name: item
description: Data bag item name.
in: path
required: true
type: string
tags:
- InfraProxy
delete:
operationId: InfraProxy_DeleteDataBagItem
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.DataBagItem'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: server_id
description: Chef Infra Server ID.
in: path
required: true
type: string
- name: org_id
description: Chef organization ID.
in: path
required: true
type: string
- name: name
description: Data bag name.
in: path
required: true
type: string
- name: item
description: Data bag item name.
in: path
required: true
type: string
tags:
- InfraProxy
/api/v0/infra/servers/{server_id}/orgs/{org_id}/environments:
get:
operationId: InfraProxy_GetEnvironments
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.Environments'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: server_id
description: Chef Infra Server ID.
in: path
required: true
type: string
- name: org_id
description: Chef organization ID.
in: path
required: true
type: string
- name: search_query.q
description: The search query used to identify a list of items.
in: query
required: false
type: string
- name: search_query.page
description: Starting page for the results.
in: query
required: false
type: integer
format: int32
- name: search_query.per_page
description: The number of results on each page.
in: query
required: false
type: integer
format: int32
tags:
- InfraProxy
post:
operationId: InfraProxy_CreateEnvironment
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.Environment'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: server_id
description: Chef Infra Server ID.
in: path
required: true
type: string
- name: org_id
description: Chef organization ID.
in: path
required: true
type: string
- name: body
in: body
required: true
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.request.CreateEnvironment'
tags:
- InfraProxy
/api/v0/infra/servers/{server_id}/orgs/{org_id}/environments/{name}:
get:
operationId: InfraProxy_GetEnvironment
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.Environment'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: server_id
description: Chef Infra Server ID.
in: path
required: true
type: string
- name: org_id
description: Chef organization ID.
in: path
required: true
type: string
- name: name
description: Environment name.
in: path
required: true
type: string
tags:
- InfraProxy
delete:
operationId: InfraProxy_DeleteEnvironment
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.Environment'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: server_id
description: Chef Infra Server ID.
in: path
required: true
type: string
- name: org_id
description: Chef organization ID.
in: path
required: true
type: string
- name: name
description: Environment name.
in: path
required: true
type: string
tags:
- InfraProxy
put:
operationId: InfraProxy_UpdateEnvironment
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.Environment'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: server_id
description: Chef Infra Server ID.
in: path
required: true
type: string
- name: org_id
description: Chef organization ID.
in: path
required: true
type: string
- name: name
description: Environment name.
in: path
required: true
type: string
- name: body
in: body
required: true
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.request.UpdateEnvironment'
tags:
- InfraProxy
/api/v0/infra/servers/{server_id}/orgs/{org_id}/environments/{name}/recipes:
get:
operationId: InfraProxy_GetEnvironmentRecipes
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.EnvironmentRecipesList'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: server_id
description: Chef Infra Server ID.
in: path
required: true
type: string
- name: org_id
description: Chef organization ID.
in: path
required: true
type: string
- name: name
description: Environment name.
in: path
required: true
type: string
tags:
- InfraProxy
/api/v0/infra/servers/{server_id}/orgs/{org_id}/node/{name}/runlist/{environment}:
get:
operationId: InfraProxy_GetNodeExpandedRunList
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.NodeExpandedRunList'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: server_id
description: Chef Infra Server ID.
in: path
required: true
type: string
- name: org_id
description: Chef organization ID.
in: path
required: true
type: string
- name: name
description: Node name.
in: path
required: true
type: string
- name: environment
description: Node environment.
in: path
required: true
type: string
tags:
- InfraProxy
/api/v0/infra/servers/{server_id}/orgs/{org_id}/nodes:
get:
operationId: InfraProxy_GetNodes
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.Nodes'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/grpc.gateway.runtime.Error'
parameters:
- name: server_id
description: Chef Infra Server ID.
in: path
required: true
type: string
- name: org_id
description: Chef organization ID.
in: path
required: true
type: string
- name: search_query.q
description: The search query used to identify a list of items.
in: query
required: false
type: string
- name: search_query.page
description: Starting page for the results.
in: query
required: false
type: integer
format: int32
- name: search_query.per_page
description: The number of results on each page.
in: query
required: false
type: integer
format: int32
tags:
- InfraProxy
/api/v0/infra/servers/{server_id}/orgs/{org_id}/nodes/{name}:
get:
operationId: InfraProxy_GetNode
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/chef.automate.api.infra_proxy.response.Node'
default:
d
# --- truncated at 32 KB (88 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/chef-software/refs/heads/main/openapi/chef-software-infraproxy-api-openapi.yml