API Reference
v2
Refer Rio OS - v2 in SwaggerHub: OpenAPI specification
Caution API is subject to change until 2.0 is released.
/healthz
GET
Responses
200
API service is healthy
500
API service isn't reachable
503
API service temporarily unavailable
default
unexpected error
GET
Responses
200 API service is healthy
500 API service isn't reachable
503 API service temporarily unavailable
default unexpected error
/healthz/overall
GET
Responses
200
metrics data response
default
unexpected error
GET
Responses
200 metrics data response
default unexpected error
/authenticate
POST
Login with email and password
Responses
201
authenticated
400
invalid input
500
internal seiceer error
409
input conflict
default
unexpected error
POST Login with email and password
Responses
201 authenticated
400 invalid input
500 internal seiceer error
409 input conflict
default unexpected error
/accounts/{account_id}/assemblys
POST
Create new assembly
Parameters
Name
Located in
Description
Type
account_id
path
id ofthe account_id
String
Responses
200
succesfull creation of assembly
400
Must supply required fields
Can't parse body, as its invalid/malformed"
401
UnAuthorized
402
Must have entitlement to use Rio/OS.
403
Forbidden, Must have roles and permission to perform action on the resource.
500
Can't connect with database, blockchain (or) other systems for processing.
GET
Get all assemblys by account
Parameters
Name
Located in
Description
Type
account_id
path
account id of assembly to return
String
Responses
200
successful operation
401
UnAuthorized
402
Must have entitlement to use Rio/OS.
403
Forbidden, Must have roles and permission to perform action on the resource.
404
assemblys not found
500
Can't connect with database, blockchain (or) other systems for processing.
POST Create new assembly
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| account_id | path | id ofthe account_id | String |
Responses
200 succesfull creation of assembly
400 Must supply required fields Can't parse body, as its invalid/malformed"
401 UnAuthorized
402 Must have entitlement to use Rio/OS.
403 Forbidden, Must have roles and permission to perform action on the resource.
500 Can't connect with database, blockchain (or) other systems for processing.
GET Get all assemblys by account
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| account_id | path | account id of assembly to return | String |
Responses
200 successful operation
401 UnAuthorized
402 Must have entitlement to use Rio/OS.
403 Forbidden, Must have roles and permission to perform action on the resource.
404 assemblys not found
500 Can't connect with database, blockchain (or) other systems for processing.
/assemblys
GET
Get all assembly
Responses
200
successful operation
401
UnAuthorized
402
Must have entitlement to use Rio/OS.
403
Forbidden, Must have roles and permission to perform action on the resource.
404
assemblys not found
500
Can't connect with database, blockchain (or) other systems for processing.
GET Get all assembly
Responses
200 successful operation
401 UnAuthorized
402 Must have entitlement to use Rio/OS.
403 Forbidden, Must have roles and permission to perform action on the resource.
404 assemblys not found
500 Can't connect with database, blockchain (or) other systems for processing.
/assemblys/{assemblyId}
GET
Find assembly by ID
Parameters
Name
Located in
Description
Type
assemblyId
path
ID of assembly to return
String
Responses
200
successful operation
401
UnAuthorized
402
Must have entitlement to use Rio/OS.
403
Forbidden, Must have roles and permission to perform action on the resource.
404
assemblys not found
500
Can't connect with database, blockchain (or) other systems for processing.
PUT
Update assembly by ID
Parameters
Name
Located in
Description
Type
assemblyId
path
ID of assembly to return
String
Responses
200
successful operation
400
Must supply required fields
Can't parse body, as its invalid/malformed"
401
UnAuthorized
402
Must have entitlement to use Rio/OS.
403
Forbidden, Must have roles and permission to perform action on the resource.
404
assemblys not found
500
Can't connect with database, blockchain (or) other systems for processing.
GET Find assembly by ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| assemblyId | path | ID of assembly to return | String |
Responses
200 successful operation
401 UnAuthorized
402 Must have entitlement to use Rio/OS.
403 Forbidden, Must have roles and permission to perform action on the resource.
404 assemblys not found
500 Can't connect with database, blockchain (or) other systems for processing.
PUT Update assembly by ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| assemblyId | path | ID of assembly to return | String |
Responses
200 successful operation
400 Must supply required fields Can't parse body, as its invalid/malformed"
401 UnAuthorized
402 Must have entitlement to use Rio/OS.
403 Forbidden, Must have roles and permission to perform action on the resource.
404 assemblys not found
500 Can't connect with database, blockchain (or) other systems for processing.
/assemblys/{assemblyId}/status
PUT
Update assembly status by ID
Parameters
Name
Located in
Description
Type
assemblyId
path
ID of assembly to return
String
Responses
200
successful operation
400
Must supply required fields
Can't parse body, as its invalid/malformed"
401
UnAuthorized
402
Must have entitlement to use Rio/OS.
403
Forbidden, Must have roles and permission to perform action on the resource.
404
assemblys not found
500
Can't connect with database, blockchain (or) other systems for processing.
PUT Update assembly status by ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| assemblyId | path | ID of assembly to return | String |
Responses
200 successful operation
400 Must supply required fields Can't parse body, as its invalid/malformed"
401 UnAuthorized
402 Must have entitlement to use Rio/OS.
403 Forbidden, Must have roles and permission to perform action on the resource.
404 assemblys not found
500 Can't connect with database, blockchain (or) other systems for processing.
/accounts
POST
Create new account
Responses
200
successful creation of the account
400
Must supply required fields
Can't parse body, as its invalid/malformed"
500
DB error
POST Create new account
Responses
200 successful creation of the account
400 Must supply required fields Can't parse body, as its invalid/malformed"
500 DB error
/accounts/{id}
GET
Find account by ID
Parameters
Name
Located in
Description
Type
id
path
ID of account to return
String
Responses
200
successful operation
404
Account not found
GET Find account by ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| id | path | ID of account to return | String |
Responses
200 successful operation
404 Account not found
/accounts/name/{email}
GET
Find account by email
Parameters
Name
Located in
Description
Type
email
path
email of account to return
String
Responses
200
successful operation
404
Account not found
GET Find account by email
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| path | email of account to return | String |
Responses
200 successful operation
404 Account not found
/origins
POST
Create new origin
Responses
200
successful creation of the origin
400
Must supply required fields
Can't parse body, as its invalid/malformed"
500
DB error
GET
Get all origins
Responses
200
successful operation
500
DB error
POST Create new origin
Responses
200 successful creation of the origin
400 Must supply required fields Can't parse body, as its invalid/malformed"
500 DB error
GET Get all origins
Responses
200 successful operation
500 DB error
/origins/{name}
GET
Find origins by ID
Parameters
Name
Located in
Description
Type
name
path
name of origins to return
String
Responses
200
successful operation
404
Account not found
GET Find origins by ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| name | path | name of origins to return | String |
Responses
200 successful operation
404 Account not found
/services
GET
Get all the services
Responses
200
services response
404
services not found
POST
Create new DNS service
Responses
200
successful creation of the DNS service
400
Must supply required fields
Can't parse body, as its invalid/malformed"
500
DB error
GET Get all the services
Responses
200 services response
404 services not found
POST Create new DNS service
Responses
200 successful creation of the DNS service
400 Must supply required fields Can't parse body, as its invalid/malformed"
500 DB error
/services/{servicesid}
GET
Find services by ID
Parameters
Name
Located in
Description
Type
servicesid
path
ID of service to return
String
Responses
200
successful operation
404
service not found
GET Find services by ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| servicesid | path | ID of service to return | String |
Responses
200 successful operation
404 service not found
/endpoints
POST
Create new endpoints
Responses
200
successful creation of endpoints
400
Must supply required fields
Can't parse body, as its invalid/malformed"
500
DB error
GET
Get all endpoints
Responses
200
successful operation
404
endpoints not found
POST Create new endpoints
Responses
200 successful creation of endpoints
400 Must supply required fields Can't parse body, as its invalid/malformed"
500 DB error
GET Get all endpoints
Responses
200 successful operation
404 endpoints not found
/endpoints/{EndpointsId}
GET
Find endpoints by ID
Parameters
Name
Located in
Description
Type
EndpointsId
path
ID of endpoint to return
String
Responses
200
successful operation
404
endpoints not found
GET Find endpoints by ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| EndpointsId | path | ID of endpoint to return | String |
Responses
200 successful operation
404 endpoints not found
/endpoints/assembly/{id}
GET
Find endpoint by assembly id
Parameters
Name
Located in
Description
Type
id
path
assembly id of endpoints to return
String
Responses
200
successful operation
404
endpoints not found
GET Find endpoint by assembly id
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| id | path | assembly id of endpoints to return | String |
Responses
200 successful operation
404 endpoints not found
/datacenters
POST
Create new datacenter
Responses
200
datacenter created successfully
400
Must supply required fields
Can't parse body, as its invalid/malformed"
401
UnAuthorized
402
Must have entitlement to use Rio/OS.
403
Forbidden, Must have roles and permission to perform action on the resource.
500
Can't connect with database, blockchain (or) other systems for processing.
GET
Get all datacenter
Responses
200
datacenter response
401
UnAuthorized
402
Must have entitlement to use Rio/OS.
403
Forbidden, Must have roles and permission to perform action on the resource.
404
network not found
500
Can't connect with database, blockchain (or) other systems for processing.
POST Create new datacenter
Responses
200 datacenter created successfully
400 Must supply required fields Can't parse body, as its invalid/malformed"
401 UnAuthorized
402 Must have entitlement to use Rio/OS.
403 Forbidden, Must have roles and permission to perform action on the resource.
500 Can't connect with database, blockchain (or) other systems for processing.
GET Get all datacenter
Responses
200 datacenter response
401 UnAuthorized
402 Must have entitlement to use Rio/OS.
403 Forbidden, Must have roles and permission to perform action on the resource.
404 network not found
500 Can't connect with database, blockchain (or) other systems for processing.
/datacenters/{datacenterId}
GET
Find datacenter by ID
Parameters
Name
Located in
Description
Type
datacenterId
path
ID of datacenter to return
String
Responses
200
successful operation
500
Can't connect with database, blockchain (or) other systems for processing.
401
UnAuthorized
402
Must have entitlement to use Rio/OS.
403
Forbidden, Must have roles and permission to perform action on the resource.
404
datacenter not found
GET Find datacenter by ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| datacenterId | path | ID of datacenter to return | String |
Responses
200 successful operation
500 Can't connect with database, blockchain (or) other systems for processing.
401 UnAuthorized
402 Must have entitlement to use Rio/OS.
403 Forbidden, Must have roles and permission to perform action on the resource.
404 datacenter not found
/storagespool
POST
Create new storaglepool
Responses
200
successful creation of storagepool
400
Must supply required fields
Can't parse body, as its invalid/malformed"
500
DB error
GET
Get all storagespool
Responses
200
storages response
404
storagepool not found
POST Create new storaglepool
Responses
200 successful creation of storagepool
400 Must supply required fields Can't parse body, as its invalid/malformed"
500 DB error
GET Get all storagespool
Responses
200 storages response
404 storagepool not found
/storageconnectors/{storageconnectorId}/storagespool
GET
Find storagespool by connector ID
Parameters
Name
Located in
Description
Type
storageconnectorId
path
ID of storagespool to return
String
Responses
200
successful operation
404
storagepool not found
GET Find storagespool by connector ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| storageconnectorId | path | ID of storagespool to return | String |
Responses
200 successful operation
404 storagepool not found
/storagespool/{Id}
GET
Get storagespool by Id
Parameters
Name
Located in
Description
Type
Id
path
ID of storagespool to return
String
Responses
200
storages response
404
storagepool not found
GET Get storagespool by Id
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| Id | path | ID of storagespool to return | String |
Responses
200 storages response
404 storagepool not found
/storagespool/{storagepoolId}/status
PUT
update storagespool status by ID
Parameters
Name
Located in
Description
Type
storagepoolId
path
ID of storagespool to return
String
Responses
200
successful update operation
404
storagepool not found
500
DB error
PUT update storagespool status by ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| storagepoolId | path | ID of storagespool to return | String |
Responses
200 successful update operation
404 storagepool not found
500 DB error
/auth/saml/providers
POST
add new saml provider
Responses
201
created
400
invalid input
500
internal server error
409
input conflict
default
unexpected error
GET
all saml providers
Responses
200
saml providers response
default
unexpected error
POST add new saml provider
Responses
201 created
400 invalid input
500 internal server error
409 input conflict
default unexpected error
GET all saml providers
Responses
200 saml providers response
default unexpected error
/auth/saml/providers/{ProviderId}
GET
Find saml provider by ID
Parameters
Name
Located in
Description
Type
ProviderId
path
ID of saml provider to return
String
Responses
200
successful operation
400
Invalid ID supplied
404
Assembly not found
500
Inter server Error
GET Find saml provider by ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| ProviderId | path | ID of saml provider to return | String |
Responses
200 successful operation
400 Invalid ID supplied
404 Assembly not found
500 Inter server Error
/auth/oidc/providers/{providerId}
POST
add new open id provider
Parameters
Name
Located in
Description
Type
providerId
path
ID of provider to create
String
Responses
201
created
400
invalid input
500
internal server error
409
input conflict
default
unexpected error
POST add new open id provider
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| providerId | path | ID of provider to create | String |
Responses
201 created
400 invalid input
500 internal server error
409 input conflict
default unexpected error
/auth/oidc/providers
GET
all open id providers
Responses
200
open id providers response
404
oidc provider not found
default
unexpected error
GET all open id providers
Responses
200 open id providers response
404 oidc provider not found
default unexpected error
/auth/oidc/providers/{ProviderId}
GET
Find open id provider by ID
Parameters
Name
Located in
Description
Type
ProviderId
path
ID of openid provider to return
String
Responses
200
successful operation
400
Invalid ID supplied
404
openid not found
500
Inter server Error
default
unexpected error
GET Find open id provider by ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| ProviderId | path | ID of openid provider to return | String |
Responses
200 successful operation
400 Invalid ID supplied
404 openid not found
500 Inter server Error
default unexpected error
/accounts/{account_id}/assemblyfactorys
POST
Create new assemblyfactorys
Parameters
Name
Located in
Description
Type
account_id
path
id of the account
String
Responses
200
successful creation of the assembly factory
400
Must supply required fields
Can't parse body, as its invalid/malformed"
401
UnAuthorized
402
Must have entitlement to use Rio/OS.
403
Forbidden, Must have roles and permission to perform action on the resource.
500
Can't connect with database, blockchain (or) other systems for processing.
GET
Get all the assembly factorys by account id
Parameters
Name
Located in
Description
Type
account_id
path
account_id of assemblyfactory to return
String
Responses
200
successful operation
401
UnAuthorized
402
Must have entitlement to use Rio/OS.
403
Forbidden, Must have roles and permission to perform action on the resource.
404
assembly factory not found
500
Can't connect with database, blockchain (or) other systems for processing.
POST Create new assemblyfactorys
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| account_id | path | id of the account | String |
Responses
200 successful creation of the assembly factory
400 Must supply required fields Can't parse body, as its invalid/malformed"
401 UnAuthorized
402 Must have entitlement to use Rio/OS.
403 Forbidden, Must have roles and permission to perform action on the resource.
500 Can't connect with database, blockchain (or) other systems for processing.
GET Get all the assembly factorys by account id
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| account_id | path | account_id of assemblyfactory to return | String |
Responses
200 successful operation
401 UnAuthorized
402 Must have entitlement to use Rio/OS.
403 Forbidden, Must have roles and permission to perform action on the resource.
404 assembly factory not found
500 Can't connect with database, blockchain (or) other systems for processing.
/assemblyfactorys
GET
Returns all assemblyfactorys
Responses
200
assemblyfactorys response
401
UnAuthorized
402
Must have entitlement to use Rio/OS.
403
Forbidden, Must have roles and permission to perform action on the resource.
404
assembly factory not found
500
Can't connect with database, blockchain (or) other systems for processing.
GET Returns all assemblyfactorys
Responses
200 assemblyfactorys response
401 UnAuthorized
402 Must have entitlement to use Rio/OS.
403 Forbidden, Must have roles and permission to perform action on the resource.
404 assembly factory not found
500 Can't connect with database, blockchain (or) other systems for processing.
/assemblyfactorys/{assemblyFactoryId}
GET
Find assemblyfactory by ID
Parameters
Name
Located in
Description
Type
assemblyFactoryId
path
ID of assemblyfactory to return
String
Responses
200
successful operation
400
Must supply required fields
Can't parse body, as its invalid/malformed"
401
UnAuthorized
402
Must have entitlement to use Rio/OS.
403
Forbidden, Must have roles and permission to perform action on the resource.
404
assembly factory not found
500
Can't connect with database, blockchain (or) other systems for processing.
GET Find assemblyfactory by ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| assemblyFactoryId | path | ID of assemblyfactory to return | String |
Responses
200 successful operation
400 Must supply required fields Can't parse body, as its invalid/malformed"
401 UnAuthorized
402 Must have entitlement to use Rio/OS.
403 Forbidden, Must have roles and permission to perform action on the resource.
404 assembly factory not found
500 Can't connect with database, blockchain (or) other systems for processing.
/assemblyfactorys/{assemblyFactoryId}/status
PUT
update assemblyfactory status by ID
Parameters
Name
Located in
Description
Type
assemblyFactoryId
path
ID of assemblyfactory to return
String
Responses
200
successful operation
400
Must supply required fields
Can't parse body, as its invalid/malformed"
401
UnAuthorized
402
Must have entitlement to use Rio/OS.
403
Forbidden, Must have roles and permission to perform action on the resource.
404
assembly factory not found
500
Can't connect with database, blockchain (or) other systems for processing.
PUT update assemblyfactory status by ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| assemblyFactoryId | path | ID of assemblyfactory to return | String |
Responses
200 successful operation
400 Must supply required fields Can't parse body, as its invalid/malformed"
401 UnAuthorized
402 Must have entitlement to use Rio/OS.
403 Forbidden, Must have roles and permission to perform action on the resource.
404 assembly factory not found
500 Can't connect with database, blockchain (or) other systems for processing.
/assemblyfactorys/{assemblyFactoryId}/describe
GET
Find assemblys by assemblyfactory ID
Parameters
Name
Located in
Description
Type
assemblyFactoryId
path
parentId of assembly in assembly factory to return
String
Responses
200
successful operation
401
UnAuthorized
402
Must have entitlement to use Rio/OS.
403
Forbidden, Must have roles and permission to perform action on the resource.
404
assembly factory not found
500
Can't connect with database, blockchain (or) other systems for processing.
GET Find assemblys by assemblyfactory ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| assemblyFactoryId | path | parentId of assembly in assembly factory to return | String |
Responses
200 successful operation
401 UnAuthorized
402 Must have entitlement to use Rio/OS.
403 Forbidden, Must have roles and permission to perform action on the resource.
404 assembly factory not found
500 Can't connect with database, blockchain (or) other systems for processing.
/horizontalscaling
POST
Create new horizontalscaling
Responses
200
successful creation of horizontal scaling
400
Must supply required fields
Can't parse body, as its invalid/malformed"
401
UnAuthorized
402
Must have entitlement to use Rio/OS.
403
Forbidden, Must have roles and permission to perform action on the resource.
500
Can't connect with database, blockchain (or) other systems for processing.
GET
Get all horizontal scaling
Responses
200
successful operation
401
UnAuthorized
402
Must have entitlement to use Rio/OS.
403
Forbidden, Must have roles and permission to perform action on the resource.
404
horizontal scaling not found
500
Can't connect with database, blockchain (or) other systems for processing.
POST Create new horizontalscaling
Responses
200 successful creation of horizontal scaling
400 Must supply required fields Can't parse body, as its invalid/malformed"
401 UnAuthorized
402 Must have entitlement to use Rio/OS.
403 Forbidden, Must have roles and permission to perform action on the resource.
500 Can't connect with database, blockchain (or) other systems for processing.
GET Get all horizontal scaling
Responses
200 successful operation
401 UnAuthorized
402 Must have entitlement to use Rio/OS.
403 Forbidden, Must have roles and permission to perform action on the resource.
404 horizontal scaling not found
500 Can't connect with database, blockchain (or) other systems for processing.
/horizontalscaling/{HorizontalScalingId}
PUT
Update horizontalscaling by ID
Parameters
Name
Located in
Description
Type
HorizontalScalingId
path
ID of horizontalscaling to return
String
Responses
200
successful operation
400
Must supply required fields
Can't parse body, as its invalid/malformed"
401
UnAuthorized
402
Must have entitlement to use Rio/OS.
403
Forbidden, Must have roles and permission to perform action on the resource.
404
horizontal scaling not found
500
Can't connect with database, blockchain (or) other systems for processing.
PUT Update horizontalscaling by ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| HorizontalScalingId | path | ID of horizontalscaling to return | String |
Responses
200 successful operation
400 Must supply required fields Can't parse body, as its invalid/malformed"
401 UnAuthorized
402 Must have entitlement to use Rio/OS.
403 Forbidden, Must have roles and permission to perform action on the resource.
404 horizontal scaling not found
500 Can't connect with database, blockchain (or) other systems for processing.
/horizontalscaling/{HorizontalScalingId}/status
PUT
update horizontalscaling status by ID
Parameters
Name
Located in
Description
Type
HorizontalScalingId
path
ID of horizontalscaling to return
String
Responses
200
successful operation
400
Must supply required fields
Can't parse body, as its invalid/malformed"
401
UnAuthorized
402
Must have entitlement to use Rio/OS.
403
Forbidden, Must have roles and permission to perform action on the resource.
404
horizontal scaling not found
500
Can't connect with database, blockchain (or) other systems for processing.
PUT update horizontalscaling status by ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| HorizontalScalingId | path | ID of horizontalscaling to return | String |
Responses
200 successful operation
400 Must supply required fields Can't parse body, as its invalid/malformed"
401 UnAuthorized
402 Must have entitlement to use Rio/OS.
403 Forbidden, Must have roles and permission to perform action on the resource.
404 horizontal scaling not found
500 Can't connect with database, blockchain (or) other systems for processing.
/horizontalscaling/{HorizontalScalingId}/scale
GET
Scale up assembly factory
Parameters
Name
Located in
Description
Type
HorizontalScalingId
path
ID of horizontal scaling
String
Responses
200
successful scale up
401
UnAuthorized
402
Must have entitlement to use Rio/OS.
403
Forbidden, Must have roles and permission to perform action on the resource.
404
horizontal scaling not found
500
Can't connect with database, blockchain (or) other systems for processing.
GET Scale up assembly factory
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| HorizontalScalingId | path | ID of horizontal scaling | String |
Responses
200 successful scale up
401 UnAuthorized
402 Must have entitlement to use Rio/OS.
403 Forbidden, Must have roles and permission to perform action on the resource.
404 horizontal scaling not found
500 Can't connect with database, blockchain (or) other systems for processing.
/horizontalscaling/assemblyfactory/{AssemblyFactoryId}
GET
Get horizontalscaling assembly factory id
Parameters
Name
Located in
Description
Type
AssemblyFactoryId
path
ID of the assembly factory
String
Responses
200
successful operation
401
UnAuthorized
402
Must have entitlement to use Rio/OS.
403
Forbidden, Must have roles and permission to perform action on the resource.
404
horizontal scaling not found
500
Can't connect with database, blockchain (or) other systems for processing.
GET Get horizontalscaling assembly factory id
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| AssemblyFactoryId | path | ID of the assembly factory | String |
Responses
200 successful operation
401 UnAuthorized
402 Must have entitlement to use Rio/OS.
403 Forbidden, Must have roles and permission to perform action on the resource.
404 horizontal scaling not found
500 Can't connect with database, blockchain (or) other systems for processing.
/horizontalscaling/{AssemblyFactoryId}/metrics(ques)source={sourceName}&job={jobName}
GET
Get assembly factory metrics
Parameters
Name
Located in
Description
Type
AssemblyFactoryId
path
ID of assembly factory
String
sourceName
path
name of the source to get machine/container metric(Ex - container_cpu_user_seconds_total/node_cpu)
String
jobName
path
name of the job to get machine/container metric(Ex - rioos_sh_containers/rioos_sh_machines)
String
Responses
200
successful operation
401
UnAuthorized
402
Must have entitlement to use Rio/OS.
403
Forbidden, Must have roles and permission to perform action on the resource.
404
metrics not found
500
Can't connect with database, blockchain (or) other systems for processing.
GET Get assembly factory metrics
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| AssemblyFactoryId | path | ID of assembly factory | String |
| sourceName | path | name of the source to get machine/container metric(Ex - container_cpu_user_seconds_total/node_cpu) | String |
| jobName | path | name of the job to get machine/container metric(Ex - rioos_sh_containers/rioos_sh_machines) | String |
Responses
200 successful operation
401 UnAuthorized
402 Must have entitlement to use Rio/OS.
403 Forbidden, Must have roles and permission to perform action on the resource.
404 metrics not found
500 Can't connect with database, blockchain (or) other systems for processing.
/roles
POST
add new role
Responses
201
created
400
invalid input
500
internal server error
409
input conflict
default
unexpected error
GET
all roles
Responses
200
roles response
default
unexpected error
POST add new role
Responses
201 created
400 invalid input
500 internal server error
409 input conflict
default unexpected error
GET all roles
Responses
200 roles response
default unexpected error
/roles/{id}
GET
Find role by ID
Parameters
Name
Located in
Description
Type
id
path
ID of openid provider to return
String
Responses
200
successful operation
400
Invalid ID supplied
404
Assembly not found
500
Inter server Error
GET Find role by ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| id | path | ID of openid provider to return | String |
Responses
200 successful operation
400 Invalid ID supplied
404 Assembly not found
500 Inter server Error
/permissions
POST
add new permissions
Responses
201
created
400
invalid input
500
internal server error
409
input conflict
GET
all permissions
Responses
200
permissions response
default
unexpected error
POST add new permissions
Responses
201 created
400 invalid input
500 internal server error
409 input conflict
GET all permissions
Responses
200 permissions response
default unexpected error
/permissions/{Id}
GET
Find permissionsr by ID
Parameters
Name
Located in
Description
Type
Id
path
ID of permission to return
String
Responses
200
successful operation
400
Invalid ID supplied
404
Assembly not found
500
Inter server Error
GET Find permissionsr by ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| Id | path | ID of permission to return | String |
Responses
200 successful operation
400 Invalid ID supplied
404 Assembly not found
500 Inter server Error
/permissions/roles/{RolesId}
GET
Find permissionsr by ID
Parameters
Name
Located in
Description
Type
RolesId
path
ID of permission to return
String
Responses
200
successful operation
400
Invalid ID supplied
404
Assembly not found
500
Inter server Error
GET Find permissionsr by ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| RolesId | path | ID of permission to return | String |
Responses
200 successful operation
400 Invalid ID supplied
404 Assembly not found
500 Inter server Error
/permissions/{Id}/roles/{RolesId}
GET
Find permissionsr by ID
Parameters
Name
Located in
Description
Type
Id
path
ID of permission to return
String
RolesId
path
ID of the Roles
String
Responses
200
successful operation
400
Invalid ID supplied
404
Assembly not found
500
Inter server Error
GET Find permissionsr by ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| Id | path | ID of permission to return | String |
| RolesId | path | ID of the Roles | String |
Responses
200 successful operation
400 Invalid ID supplied
404 Assembly not found
500 Inter server Error
/nodes
POST
Create new nodes
Responses
200
successful creation of the node
400
Must supply required fields
Can't parse body, as its invalid/malformed"
500
DB error
GET
Returns all nodes
Responses
200
successful operation
404
nodes not found
POST Create new nodes
Responses
200 successful creation of the node
400 Must supply required fields Can't parse body, as its invalid/malformed"
500 DB error
GET Returns all nodes
Responses
200 successful operation
404 nodes not found
/nodes/{nodeid}
GET
Find nodes by ID
Parameters
Name
Located in
Description
Type
nodeid
path
ID of node to return
String
Responses
200
successful operation
404
node not found
GET Find nodes by ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| nodeid | path | ID of node to return | String |
Responses
200 successful operation
404 node not found
/accounts/{Id}/secrets
POST
Create new secrets
Parameters
Name
Located in
Description
Type
Id
path
ID of account to create
String
Responses
200
successful creation of the secret
400
Must supply required fields
Can't parse body, as its invalid/malformed"
500
DB error
GET
Returns all secrets by account
Parameters
Name
Located in
Description
Type
Id
path
ID of account secret to return
String
Responses
200
successful operation
404
secret not found
500
DB error
POST Create new secrets
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| Id | path | ID of account to create | String |
Responses
200 successful creation of the secret
400 Must supply required fields Can't parse body, as its invalid/malformed"
500 DB error
GET Returns all secrets by account
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| Id | path | ID of account secret to return | String |
Responses
200 successful operation
404 secret not found
500 DB error
/secrets
GET
Returns all secrets
Responses
200
successful operation
404
secret not found
500
DB error
GET Returns all secrets
Responses
200 successful operation
404 secret not found
500 DB error
/secrets/{secretsId}
GET
Find secrets by ID
Parameters
Name
Located in
Description
Type
secretsId
path
ID of secret to return
String
Responses
200
successful operation
404
secret not found
500
DB error
GET Find secrets by ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| secretsId | path | ID of secret to return | String |
Responses
200 successful operation
404 secret not found
500 DB error
/origins/{Origin}/secrets/{SecretName}
GET
Returns secrets by origin and secret name
Parameters
Name
Located in
Description
Type
Origin
path
origin name of secrets to return
String
SecretName
path
secret name of secrets to return
String
Responses
200
successful operation
404
secret not found
500
DB error
GET Returns secrets by origin and secret name
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| Origin | path | origin name of secrets to return | String |
| SecretName | path | secret name of secrets to return | String |
Responses
200 successful operation
404 secret not found
500 DB error
/origins/{origin}/serviceaccounts
POST
Create new serviceaccounts
Parameters
Name
Located in
Description
Type
origin
path
name of the origin to create service account
String
Responses
200
successful creation of service account
400
Must supply required fields
Can't parse body, as its invalid/malformed"
500
DB error
POST Create new serviceaccounts
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| origin | path | name of the origin to create service account | String |
Responses
200 successful creation of service account
400 Must supply required fields Can't parse body, as its invalid/malformed"
500 DB error
/origins/{origin}/serviceaccounts/{ServiceAccount}
GET
Get service accounts by origin and service account name
Parameters
Name
Located in
Description
Type
origin
path
origin name of service account to return
String
ServiceAccount
path
service account name to return
String
Responses
200
successful operation
500
DB error
404
service account not found
PUT
Update service accounts service account name and origin
Parameters
Name
Located in
Description
Type
ServiceAccount
path
service account id to update
String
origin
path
origin name to update service account
String
Responses
200
successful operation
500
DB error
404
service account not found
GET Get service accounts by origin and service account name
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| origin | path | origin name of service account to return | String |
| ServiceAccount | path | service account name to return | String |
Responses
200 successful operation
500 DB error
404 service account not found
PUT Update service accounts service account name and origin
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| ServiceAccount | path | service account id to update | String |
| origin | path | origin name to update service account | String |
Responses
200 successful operation
500 DB error
404 service account not found
/serviceaccounts/{ServiceAccountName}
GET
Get service accounts service account name
Parameters
Name
Located in
Description
Type
ServiceAccountName
path
service account name to return
String
Responses
200
successful operation
500
DB error
404
service account not found
GET Get service accounts service account name
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| ServiceAccountName | path | service account name to return | String |
Responses
200 successful operation
500 DB error
404 service account not found
/serviceaccounts
GET
Get all service accounts
Responses
200
service accounts response
500
DB error
404
service account not found
GET Get all service accounts
Responses
200 service accounts response
500 DB error
404 service account not found
/networks
POST
Create new network
Responses
200
successful creation of network
400
Must supply required fields
Can't parse body, as its invalid/malformed"
401
UnAuthorized
402
Must have entitlement to use Rio/OS.
403
Forbidden, Must have roles and permission to perform action on the resource.
500
Can't connect with database, blockchain (or) other systems for processing.
GET
Get all networks
Responses
200
network response
404
network not found
500
Can't connect with database, blockchain (or) other systems for processing.
401
Unauthorized authentication
POST Create new network
Responses
200 successful creation of network
400 Must supply required fields Can't parse body, as its invalid/malformed"
401 UnAuthorized
402 Must have entitlement to use Rio/OS.
403 Forbidden, Must have roles and permission to perform action on the resource.
500 Can't connect with database, blockchain (or) other systems for processing.
GET Get all networks
Responses
200 network response
404 network not found
500 Can't connect with database, blockchain (or) other systems for processing.
401 Unauthorized authentication
/networks/{id}
GET
Get network by ID
Parameters
Name
Located in
Description
Type
id
path
ID of network to return
String
Responses
200
successful operation
400
Must supply required fields
Can't parse body, as its invalid/malformed"
401
UnAuthorized
402
Must have entitlement to use Rio/OS.
403
Forbidden, Must have roles and permission to perform action on the resource.
404
network not found
500
Can't connect with database, blockchain (or) other systems for processing.
PUT
Update network by ID
Parameters
Name
Located in
Description
Type
id
path
ID of network to return
String
Responses
200
successful operation
400
Must supply required fields
Can't parse body, as its invalid/malformed"
401
UnAuthorized
402
Must have entitlement to use Rio/OS.
403
Forbidden, Must have roles and permission to perform action on the resource.
404
network not found
500
Can't connect with database, blockchain (or) other systems for processing.
GET Get network by ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| id | path | ID of network to return | String |
Responses
200 successful operation
400 Must supply required fields Can't parse body, as its invalid/malformed"
401 UnAuthorized
402 Must have entitlement to use Rio/OS.
403 Forbidden, Must have roles and permission to perform action on the resource.
404 network not found
500 Can't connect with database, blockchain (or) other systems for processing.
PUT Update network by ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| id | path | ID of network to return | String |
Responses
200 successful operation
400 Must supply required fields Can't parse body, as its invalid/malformed"
401 UnAuthorized
402 Must have entitlement to use Rio/OS.
403 Forbidden, Must have roles and permission to perform action on the resource.
404 network not found
500 Can't connect with database, blockchain (or) other systems for processing.
/storageconnectors
POST
Create new storageconnectors
Responses
200
successful creation of storage
400
Must supply required fields
Can't parse body, as its invalid/malformed"
GET
Get all storageconnectors
Responses
200
storageconnectors response
404
storage not found
POST Create new storageconnectors
Responses
200 successful creation of storage
400 Must supply required fields Can't parse body, as its invalid/malformed"
GET Get all storageconnectors
Responses
200 storageconnectors response
404 storage not found
/storageconnectors/{Id}
PUT
Update storageconnectors by ID
Parameters
Name
Located in
Description
Type
Id
path
ID of storageconnectors to return
String
Responses
200
successful operation
400
Must supply required fields
Can't parse body, as its invalid/malformed"
404
storage not found
GET
Find storageconnectors by ID
Parameters
Name
Located in
Description
Type
Id
path
ID of storageconnectors to return
String
Responses
200
successful operation
404
storage not found
PUT Update storageconnectors by ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| Id | path | ID of storageconnectors to return | String |
Responses
200 successful operation
400 Must supply required fields Can't parse body, as its invalid/malformed"
404 storage not found
GET Find storageconnectors by ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| Id | path | ID of storageconnectors to return | String |
Responses
200 successful operation
404 storage not found
/storageconnectors/{Id}/status
PUT
update storageconnectors status by ID
Parameters
Name
Located in
Description
Type
Id
path
ID of storageconnectors to return
String
Responses
200
successful operation
404
storage not found
400
Must supply required fields
Can't parse body, as its invalid/malformed"
PUT update storageconnectors status by ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| Id | path | ID of storageconnectors to return | String |
Responses
200 successful operation
404 storage not found
400 Must supply required fields Can't parse body, as its invalid/malformed"
/ldap/config
POST
add new ldap
Responses
201
created
400
invalid input
500
internal server error
409
input conflict
POST add new ldap
Responses
201 created
400 invalid input
500 internal server error
409 input conflict
/jobs
POST
Create new job
Responses
200
successful creation of job
500
DB error
400
Must supply required fields
Can't parse body, as its invalid/malformed"
GET
Get all jobs
Responses
200
successful operation
POST Create new job
Responses
200 successful creation of job
500 DB error
400 Must supply required fields Can't parse body, as its invalid/malformed"
GET Get all jobs
Responses
200 successful operation
/jobs/node(ques)node_id={nodeId}
GET
Find jobs by node id
Parameters
Name
Located in
Description
Type
nodeId
path
ID of node to return job
String
Responses
200
successful operation
404
job not found
GET Find jobs by node id
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| nodeId | path | ID of node to return job | String |
Responses
200 successful operation
404 job not found
/jobs/{jobId}/status
PUT
update job status
Parameters
Name
Located in
Description
Type
jobId
path
Id of job to return
String
Responses
200
successful operation
404
Job not found
500
DB error
PUT update job status
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| jobId | path | Id of job to return | String |
Responses
200 successful operation
404 Job not found
500 DB error
/plans
POST
Create plan factory
Responses
200'
successful creation of the plan
500
DB error
400
Must supply required fields
Can't parse body, as its invalid/malformed"
GET
Return all plan
Responses
200
successful operation
404
plans not found
POST Create plan factory
Responses
200' successful creation of the plan
500 DB error
400 Must supply required fields Can't parse body, as its invalid/malformed"
GET Return all plan
Responses
200 successful operation
404 plans not found
/plans/{id}
GET
Find plan by ID
Parameters
Name
Located in
Description
Type
id
path
ID of plan to return
String
Responses
200
successful operation
404
Plan not found
GET Find plan by ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| id | path | ID of plan to return | String |
Responses
200 successful operation
404 Plan not found
/verticalscaling
POST
Create new Vertical scaling
Responses
200
successful creation of vertical scaling
500
DB error
GET
Get all vertical scaling
Responses
200
successful opertaion
404
vertical scaling not found
POST Create new Vertical scaling
Responses
200 successful creation of vertical scaling
500 DB error
GET Get all vertical scaling
Responses
200 successful opertaion
404 vertical scaling not found
/verticalscaling/{VerticalScalingId}
PUT
Update vertical scaling by id
Parameters
Name
Located in
Description
Type
VerticalScalingId
path
ID of vertical scaling to update
String
Responses
200
successful operation
400
Must supply required fields
Can't parse body, as its invalid/malformed"
500
DB error
404
verical scaling not found
PUT Update vertical scaling by id
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| VerticalScalingId | path | ID of vertical scaling to update | String |
Responses
200 successful operation
400 Must supply required fields Can't parse body, as its invalid/malformed"
500 DB error
404 verical scaling not found
/verticalscaling/scale/{id}
GET
vertical scale up/down
Parameters
Name
Located in
Description
Type
id
path
ID of vertical scale up or down
String
Responses
404
verical scale not found
500
DB error
200
successful operation
GET vertical scale up/down
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| id | path | ID of vertical scale up or down | String |
Responses
404 verical scale not found
500 DB error
200 successful operation
/verticalscaling/{id}/status
PUT
Update vertical scaling status
Parameters
Name
Located in
Description
Type
id
path
ID of vertical scaling status to update
String
Responses
404
verical scaling not found
500
DB error
200
successful operation
PUT Update vertical scaling status
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| id | path | ID of vertical scaling status to update | String |
Responses
404 verical scaling not found
500 DB error
200 successful operation
/volumes
POST
Create new Volumes
Responses
200
successful creation of volume
500
DB error
POST Create new Volumes
Responses
200 successful creation of volume
500 DB error
/volumes/{id}
GET
Get volume by id
Parameters
Name
Located in
Description
Type
id
path
ID of the volume return
String
Responses
200
successful operation
404
volume not found
PUT
Update volume by id
Parameters
Name
Located in
Description
Type
id
path
ID of volume to update
String
Responses
200
successful operation
400
Must supply required fields
Can't parse body, as its invalid/malformed"
500
DB error
404
volume not found
GET Get volume by id
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| id | path | ID of the volume return | String |
Responses
200 successful operation
404 volume not found
PUT Update volume by id
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| id | path | ID of volume to update | String |
Responses
200 successful operation
400 Must supply required fields Can't parse body, as its invalid/malformed"
500 DB error
404 volume not found
/volumes/{id}/status
PUT
Update volume status by id
Parameters
Name
Located in
Description
Type
id
path
ID of volume status to update
String
Responses
200
successful operation
400
Must supply required fields
Can't parse body, as its invalid/malformed"
500
DB error
404
volume not found
PUT Update volume status by id
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| id | path | ID of volume status to update | String |
Responses
200 successful operation
400 Must supply required fields Can't parse body, as its invalid/malformed"
500 DB error
404 volume not found
/assemblys/{id}/volumes
GET
Get all volumes by assembly id
Parameters
Name
Located in
Description
Type
id
path
ID of the assembly volumes return
String
Responses
200
successful operation
404
volumes not found
GET Get all volumes by assembly id
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| id | path | ID of the assembly volumes return | String |
Responses
200 successful operation
404 volumes not found
/settingsmap
POST
Create new Settings map
Responses
200
successful creation of settings map
500
DB error
POST Create new Settings map
Responses
200 successful creation of settings map
500 DB error
/origins/{origin}/settingsmap/{name}
GET
Get settings map by origin and settingsmap name
Parameters
Name
Located in
Description
Type
origin
path
name of the origin return
String
name
path
name of the settingsmap return
String
Responses
200
successful operation
404
settingsmap not found
GET Get settings map by origin and settingsmap name
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| origin | path | name of the origin return | String |
| name | path | name of the settingsmap return | String |
Responses
200 successful operation
404 settingsmap not found
/logs/{assembly_id}(ques)range=10m&limits=1
GET
Get logs by assembly id
Parameters
Name
Located in
Description
Type
assembly_id
path
ID of the assembly logs return
String
Responses
200
successful operation
404
Assembly log not found
500
Inflexdb connection refused
GET Get logs by assembly id
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| assembly_id | path | ID of the assembly logs return | String |
Responses
200 successful operation
404 Assembly log not found
500 Inflexdb connection refused
/logs(ques)limits=1&range=15m
GET
Get all the assembly logs
Responses
200
successful operation
404
Assemblys log not found
500
Inflexdb connection refused
GET Get all the assembly logs
Responses
200 successful operation
404 Assemblys log not found
500 Inflexdb connection refused
/image/{ImageName}/vulnerablity
GET
Get vulnerablity check response of Image
Parameters
Name
Located in
Description
Type
ImageName
path
Name of the image vulnerablity return
String
Responses
200
successful operation
404
image not found
500
anchore connection refused
GET Get vulnerablity check response of Image
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| ImageName | path | Name of the image vulnerablity return | String |
Responses
200 successful operation
404 image not found
500 anchore connection refused
/accounts/{accountId}/audits
POST
Create new audit by account id
Parameters
Name
Located in
Description
Type
accountId
path
Id of the account user audit return
String
Responses
200
successful creation audit using account id
500
Blockchain Connection refused
GET
Get all audits for the account id
Parameters
Name
Located in
Description
Type
accountId
path
Id of the account user audit return
String
Responses
200
successful operation
404
audit not found
500
blockchain connection refused
POST Create new audit by account id
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| accountId | path | Id of the account user audit return | String |
Responses
200 successful creation audit using account id
500 Blockchain Connection refused
GET Get all audits for the account id
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| accountId | path | Id of the account user audit return | String |
Responses
200 successful operation
404 audit not found
500 blockchain connection refused
/buildconfig
POST
Create new build config
Responses
200
successful creation build config
500
DB error
GET
Get all build config
Responses
200
successful operation
404
build config not found
500
DB error
POST Create new build config
Responses
200 successful creation build config
500 DB error
GET Get all build config
Responses
200 successful operation
404 build config not found
500 DB error
/buildconfig/{id}
GET
Get build config by id
Parameters
Name
Located in
Description
Type
id
path
Id of the build config to return
String
Responses
200
successful operation
404
build config not found
500
DB error
GET Get build config by id
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| id | path | Id of the build config to return | String |
Responses
200 successful operation
404 build config not found
500 DB error
/buildconfig/assemblyfactorys/{id}
GET
Get build config by assembly factory id
Parameters
Name
Located in
Description
Type
id
path
Id of the assembly factory to return build config
String
Responses
200
successful operation
404
build config not found
500
DB error
GET Get build config by assembly factory id
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| id | path | Id of the assembly factory to return build config | String |
Responses
200 successful operation
404 build config not found
500 DB error
/builds
POST
Create new build
Responses
200
successful creation builds
500
DB error
GET
Get all builds
Responses
200
successful operation
404
build not found
500
DB error
POST Create new build
Responses
200 successful creation builds
500 DB error
GET Get all builds
Responses
200 successful operation
404 build not found
500 DB error
/builds/{id}
GET
Get build by id
Parameters
Name
Located in
Description
Type
id
path
Id of the build to return
String
Responses
200
successful operation
404
build not found
500
DB error
GET Get build by id
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| id | path | Id of the build to return | String |
Responses
200 successful operation
404 build not found
500 DB error
/builds/buildconfig/{id}
GET
Get build by build config id
Parameters
Name
Located in
Description
Type
id
path
Id of the build config to return builds
String
Responses
200
successful operation
404
build not found
500
DB error
GET Get build by build config id
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| id | path | Id of the build config to return builds | String |
Responses
200 successful operation
404 build not found
500 DB error
/imageref
POST
Create new image reference
Responses
200
successful creation imageref
500
DB error
POST Create new image reference
Responses
200 successful creation imageref
500 DB error
/imageref/{id}
GET
Get image reference by id
Parameters
Name
Located in
Description
Type
id
path
Id of the imageref to return
String
Responses
200
successful operation
404
imageref not found
500
DB error
GET Get image reference by id
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| id | path | Id of the imageref to return | String |