Services

List Services

get

Gets a page of service objects.

Args: filter_model: Filter model used for pagination, sorting, filtering. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response.

Returns: Page of service objects.

Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
hydratebooleanOptionalDefault: false
sort_bystringOptionalDefault: created
logical_operatorstring · enumOptional

Logical Ops to use to combine filters on list methods.

Default: andPossible values:
pageinteger · min: 1OptionalDefault: 1
sizeinteger · min: 1 · max: 10000OptionalDefault: 20
idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
createdany ofOptional
string · date-timeOptional
or
stringOptional
or
nullOptional
updatedany ofOptional
string · date-timeOptional
or
stringOptional
or
nullOptional
scope_userany ofOptional
string · uuidOptional
or
nullOptional
userany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
projectany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
nameany ofOptional
stringOptional
or
nullOptional
typeany ofOptional
stringOptional
or
nullOptional
flavorany ofOptional
stringOptional
or
nullOptional
configany ofOptional
string · binaryOptional
or
nullOptional
pipeline_nameany ofOptional
stringOptional
or
nullOptional
pipeline_step_nameany ofOptional
stringOptional
or
nullOptional
runningany ofOptional
booleanOptional
or
nullOptional
model_version_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
pipeline_run_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/api/v1/services

Create Service

post

Creates a new service.

Args: service: The service to create. project_name_or_id: Optional name or ID of the project.

Returns: The created service.

Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
project_name_or_idany ofOptional
stringOptional
or
string · uuidOptional
or
nullOptional
Body

Request model for services.

userany ofOptional
string · uuidOptional
or
nullOptional
projectstring · uuidRequired
namestring · max: 255Required
service_sourceany ofOptional

The fully qualified class name of the service implementation.

stringOptional
or
nullOptional
admin_stateany ofOptional

The administrative state of the service, e.g., ACTIVE, INACTIVE.

string · enumOptional

Possible states for the service and service endpoint.

Possible values:
or
nullOptional
labelsany ofOptional
or
nullOptional
statusany ofOptional
or
nullOptional
endpointany ofOptional
or
nullOptional
prediction_urlany ofOptional
stringOptional
or
nullOptional
health_check_urlany ofOptional
stringOptional
or
nullOptional
model_version_idany ofOptional
string · uuidOptional
or
nullOptional
pipeline_run_idany ofOptional
string · uuidOptional
or
nullOptional
Responses
200

Successful Response

application/json
post
/api/v1/services

Get Service

get

Gets a specific service using its unique ID.

Args: service_id: The ID of the service to get. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response.

Returns: A specific service object.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
service_idstring · uuidRequired
Query parameters
hydratebooleanOptionalDefault: true
Responses
200

Successful Response

application/json
get
/api/v1/services/{service_id}

Update Service

put

Updates a service.

Args: service_id: The ID of the service to update. update: The model containing the attributes to update.

Returns: The updated service object.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
service_idstring · uuidRequired
Body

Update model for stack components.

nameany ofOptional
string · max: 255Optional
or
nullOptional
admin_stateany ofOptional

The administrative state of the service, e.g., ACTIVE, INACTIVE.

string · enumOptional

Possible states for the service and service endpoint.

Possible values:
or
nullOptional
service_sourceany ofOptional

The fully qualified class name of the service implementation.

stringOptional
or
nullOptional
statusany ofOptional
or
nullOptional
endpointany ofOptional
or
nullOptional
prediction_urlany ofOptional
stringOptional
or
nullOptional
health_check_urlany ofOptional
stringOptional
or
nullOptional
labelsany ofOptional
or
nullOptional
model_version_idany ofOptional
string · uuidOptional
or
nullOptional
Responses
200

Successful Response

application/json
put
/api/v1/services/{service_id}

Delete Service

delete

Deletes a specific service.

Args: service_id: The ID of the service to delete.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
service_idstring · uuidRequired
Responses
200

Successful Response

application/json
Responseany
delete
/api/v1/services/{service_id}

No content

Last updated

Was this helpful?