v1alpha1

API reference

Read application container logs from elastic search.

post
/applicationlogs
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Body

ApplicationLogsParams describes a set of parameters that can be used to build a search query for an application's logs. In most cases, only ContainerId, From, and Size are required in order to create a search query.

container_idstringOptional
container_namestringOptional
deployment_namespacestringOptional
frominteger · int64Optional
pod_namestringOptional
sizeinteger · int64Optional
Responses
post
/applicationlogs
get
/cluster

Read the cluster info

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Responses
get
/cluster
get
/healthcheck

Read the healthcheck

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Responses
get
/healthcheck
200

Version

get
/namespaces/{namespace}/experiments/{name}/gitdiff

Read the git diff for an experiment

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Query parameters
hashstringOptional

Hash

Responses
get
/namespaces/{namespace}/experiments/{name}/gitdiff
get
/namespaces/{namespace}/experiments/{name}/gitlogs

Read the git commits for an experiment

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Responses
get
/namespaces/{namespace}/experiments/{name}/gitlogs

Get inference logs metadata for seldon deployments.

get
/inference-logs/seldondeployments
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Query parameters
namespacestringOptional

The namespace that this seldon deployment belongs to.

deploymentNamestringOptional

The name of the seldon deployment to get inference logs for.

predictorNamestringOptional

The predictor name of the seldon deployment to get inference logs for. e.g. "default", "canary", "shadow"

containerNamestringOptional

The container name of the seldon deployment to get inference logs for. e.g. "my-container", "input-transformer", "output-transformer"

Responses
get
/inference-logs/seldondeployments

Get inference logs for seldon deployments.

post
/inference-logs/namespace/{namespace}/seldondeployments/{deploymentName}
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namespacestringRequired

The namespace that this seldon deployment belongs to.

deploymentNamestringRequired

The name of the seldon deployment to get inference logs for.

Body
predictorNamestringRequired

The predictor name of the seldon deployment to get inference logs for. e.g. "default", "canary", "shadow"

Example: default
containerNamestringRequired

The container name of the seldon deployment to get inference logs for. e.g. "my-container", "input-transformer", "output-transformer"

Example: my-container
startTimestring · date-timeOptional

The start time of the inference logs to get.

Example: 2020-01-01T00:00:00Z
endTimestring · date-timeOptional

The end time of the inference logs to get.

Example: 2020-01-01T00:00:00Z
limitinteger · int32Optional

The maximum number of inference logs to get.

Example: 100
pageTokenstringOptional

The page token to use to get the next page of inference logs.

Example: my-page-token
Responses
post
/inference-logs/namespace/{namespace}/seldondeployments/{deploymentName}

Get inference logs for seldon models.

post
/inference-logs/namespace/{namespace}/pipelines/{pipelineName}/models/{modelName}
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namespacestringRequired

The namespace that this seldon deployment belongs to.

pipelineNamestringRequired

The name of the seldon pipeline to get inference logs for.

modelNamestringRequired

The name of the seldon model to get inference logs for.

Body
startTimestring · date-timeOptional

The start time of the inference logs to get.

Example: 2020-01-01T00:00:00Z
endTimestring · date-timeOptional

The end time of the inference logs to get.

Example: 2020-01-01T00:00:00Z
limitinteger · int32Optional

The maximum number of inference logs to get.

Example: 100
pageTokenstringOptional

The page token to use to get the next page of inference logs.

Example: my-page-token
Responses
post
/inference-logs/namespace/{namespace}/pipelines/{pipelineName}/models/{modelName}

Get inference logs metadata for seldon models.

get
/inference-logs/models
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Query parameters
namespacestringRequired

The namespace that this seldon deployment belongs to.

pipelineNamestringRequired

The name of the seldon pipeline to get inference logs for.

modelNamestringRequired

The name of the seldon model to get inference logs for.

Responses
get
/inference-logs/models

List the current health of a specific Seldon Deploy dependency or all of them

get
/healthcheck/{dependency}
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
dependencystring · enumRequiredPossible values:
Responses
get
/healthcheck/{dependency}

Deletes the specified secret.

delete
/secrets/{namespace}/{secretType}/{name}
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namespacestringRequired

The namespace to delete secret from.

secretTypestring · enumRequired

The secret type of the secret to be deleted, can be one of (bucket, registry).

Possible values:
namestringRequired

The name of the secret to delete.

Responses
delete
/secrets/{namespace}/{secretType}/{name}

Lists the names and metadata of secrets used by Seldon Deploy.

get
/secrets/{namespace}/{secretType}
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namespacestringRequired

The namespace to list secrets in.

secretTypestring · enumRequired

The secret type, can be one of (bucket, registry) or all to list all secrets used by Seldon Deploy.

Possible values:
Query parameters
bucketSecretFormatstring · enumOptional

Optional filter for the format of bucket secrets. Only applicable when secret_type is bucket.

Possible values:
pageSizestring · int64Optional

Optional The maximum number of Secrets to return in the response.

pageTokenstringOptional

Optional pagination token returned from a previous call to List that indicates where this listing should continue from.

searchstringOptional

Optional search string for secrets.

Responses
get
/secrets/{namespace}/{secretType}

Creates a registry secret according to specified parameters.

post
/secrets/{namespace}/registry/{name}
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namespacestringRequired

The namespace to create secret in.

namestringRequired

The secret name must contain only lowercase letters, digits or dashes, must start and end with a lowercase letter or digit and must be no more than 30 characters in length.

Body
objectOptional

The raw json docker credentials config.

Responses
post
/secrets/{namespace}/registry/{name}

Creates a S3 bucket secret according to specified parameters.

post
/secrets/{namespace}/bucket/s3/{remote}
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namespacestringRequired

The namespace to create secret in.

remotestringRequired

The remote name must contain only lowercase letters, digits or dashes, must start and end with a lowercase letter or digit and must be no more than 30 characters in length. The created secret will be named {remote}-bucket-envvars or {remote}-bucket-params, for Core 1 or Core 2, respectively.

Query parameters
secretVersionstring · enumOptional

The version of the secret to use (CORE_1 or CORE_2). Default value is CORE_1

Possible values:
Body

The S3 account credentials to populate the secret. See documentation for how to generate these.

s3AccessKeyIdstringOptional

The S3 access key ID.

s3SecretAccessKeystringOptional

The S3 secret access key.

Responses
post
/secrets/{namespace}/bucket/s3/{remote}

Creates a generic rclone bucket secret according to specified parameters.

post
/secrets/{namespace}/bucket/rclone/{remote}
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namespacestringRequired

The namespace to create secret in.

remotestringRequired

The remote name must contain only lowercase letters, digits or dashes, must start and end with a lowercase letter or digit and must be no more than 30 characters in length. The created secret will be named {remote}-bucket-envvars or {remote}-bucket-params, for Core 1 or Core 2, respectively.

Query parameters
formatstring · enumOptional

The format for the secret. Must be one of (env_var, config_param). env_var formats the secret as environment variables, each with a key and a value. env_var is suitable for Seldon Core v1 and Argo Workflows. config_param formats the secret to be compatible with Rclone's HTTP API. config_param is suitable for Seldon Core v2.

Possible values:
Body

The rclone key value pairs.

remoteTypestringOptional

The Rclone type of the remote; see the Rclone documentation for available types.

Example: s3
Responses
post
/secrets/{namespace}/bucket/rclone/{remote}

Creates a GCS bucket secret according to specified parameters.

post
/secrets/{namespace}/bucket/gcs/{remote}
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namespacestringRequired

The namespace to create secret in.

remotestringRequired

The remote name must contain only lowercase letters, digits or dashes, must start and end with a lowercase letter or digit and must be no more than 30 characters in length. The created secret will be named {remote}-bucket-envvars or {remote}-bucket-params, for Core 1 or Core 2, respectively.

Query parameters
secretVersionstring · enumOptional

The version of the secret to use (CORE_V1 or CORE_V2). Default value is CORE_V1

Possible values:
Body
objectOptional

The GCS account credentials to populate the secret. See documentation for how to generate this.

Responses
post
/secrets/{namespace}/bucket/gcs/{remote}

Triggers a test alert to check alerting workflow.

post
/alerting/test
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Body
booleanOptional
Responses
post
/alerting/test

List currently firing alerts.

get
/alerting/alerts
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Responses
get
/alerting/alerts

Endpoint is available only when user management is enabled configured - refer to the docs for how to do this. Sends an email to the user with a link to reset their password. The caller must have `write` permission on `system/iam`.

post
/iam/users/{username}/resetPassword
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
usernamestringRequired

The username of the user to be deleted.

Responses
post
/iam/users/{username}/resetPassword

Endpoint is available only when user management is enabled configured - refer to the docs for how to do this. Add user to a group. The caller must have `write` permission on `system/iam`.

put
/iam/users/{username}/groups/{group}
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
usernamestringRequired

The name of the user to be added to a group.

groupstringRequired

The name of the group to which to add a user.

Responses
put
/iam/users/{username}/groups/{group}

Endpoint is available only when user management is enabled configured - refer to the docs for how to do this. Delete user from a group. The caller must have `write` permission on `system/iam`.

delete
/iam/users/{username}/groups/{group}
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
usernamestringRequired

The name of the user to be removed from a group.

groupstringRequired

The name of the group from which to remove a user.

Responses
delete
/iam/users/{username}/groups/{group}

Endpoint is available only when user management is enabled configured - refer to the docs for how to do this. List all groups of a user. The caller must have `read` permission on `system/iam`.

get
/iam/users/{username}/groups
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
usernamestringRequired

The name of the user for who to get groups.

Responses
get
/iam/users/{username}/groups

Endpoint is available only when user management is enabled configured - refer to the docs for how to do this. Delete a user. The caller must have `write` permission on `system/iam`.

delete
/iam/users/{username}
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
usernamestringRequired

The username of the user to be deleted.

Responses
delete
/iam/users/{username}

Endpoint is available only when user management is enabled configured - refer to the docs for how to do this. Create a user. The caller must have `write` permission on `system/iam`.

post
/iam/users
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Body
usernamestringRequired

The username of the user. It must consist of only letters, numbers, underscores, and dashes, and be at most 30 characters. It can be used for login and be part of policies.

emailstringRequired

The email of the user. It must be a valid email. The user will receive instructions for setting credentials on this email.

firstNamestringOptional
lastNamestringOptional
Responses
post
/iam/users

Endpoint is available only when user management is enabled configured - refer to the docs for how to do this. List users. The caller must have `read` permission on `system/iam`.

get
/iam/users
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Query parameters
usernamestringOptional

The username of the user to fetch. It must consist of only letters, numbers, underscores, and dashes, and be at most 30 characters.

emailstringOptional

The email of the user to fetch. It must be a valid email.

firstNamestringOptional
lastNamestringOptional
Responses
get
/iam/users

List all users and groups who have access to the given resource/action pair. The user calling this endpoint must have `grant` access to the given resource.

get
/iam/policy/targets
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Query parameters
actionstringRequired

The action a target should be able to perform on the given resource.

resourcestringRequired

The resource a target should have access to.

Responses
get
/iam/policy/targets

List all permissions associated with the given users and groups. A regular user will be able to see only their permissions and the permissions of their groups. A user with `read` permission on `system/iam` can see all permissions.

get
/iam/policy/permissions
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Query parameters
usersstring[]Optional

The user IDs for which to list permission.

groupsstring[]Optional

The groups for which to list permission.

callerPermissionsbooleanOptional

If true will list the permissions of the user making the request. All users have permissions to check their permissions.

Responses
get
/iam/policy/permissions

Create an authorization policy. The user must have `grant` permissions on the resource in the policy.

post
/iam/policy
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Body
Responses
post
/iam/policy

Delete an authorization policy. The user must have `grant` permissions on the resource in the policy.

delete
/iam/policy
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Query parameters
usersstring[]Optional

The user IDs from which to revoke the given resource/action permission.

groupsstring[]Optional

The groups from which to revoke the given resource/action permission.

actionstringRequired

The action part of the resource/action permission to revoke.

resourcestringRequired

The resource part of the resource/action permission to revoke.

Responses
delete
/iam/policy

Endpoint is available only when user management is enabled configured - refer to the docs for how to do this. Delete a group. The caller must have `write` permission on `system/iam`.

delete
/iam/groups/{name}
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

The name of the group to be deleted.

Responses
delete
/iam/groups/{name}

Endpoint is available only when user management is enabled configured - refer to the docs for how to do this. List all members of a group. The caller must have `read` permission on `system/iam`.

get
/iam/groups/{groupName}/members
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
groupNamestringRequired

The name of the group for which to get members.

Responses
get
/iam/groups/{groupName}/members

Endpoint is available only when user management is enabled configured - refer to the docs for how to do this. Create a group. The caller must have `write` permission on `system/iam`.

post
/iam/groups
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Body
namestringRequired

The name of the group to be created.

Responses
post
/iam/groups

Endpoint is available only when user management is enabled configured - refer to the docs for how to do this. List all groups. The caller must have `read` permission on `system/iam`.

get
/iam/groups
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Responses
get
/iam/groups

List Runtime Metadata for all deployments associated with a model.

get
/model/metadata/runtime
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Query parameters
ModelURIstringOptional
DeploymentUIDstringOptional
DeploymentNamestringOptional
DeploymentNamespacestringOptional
DeploymentStatusstring · enumOptionalPossible values:
PredictorNamestringOptional
NodeNamestringOptional
pageSizeinteger · int32Optional

Optional. The maximum number of Folders to return in the response.

pageTokenstringOptional

Optional. A pagination token returned from a previous call to List that indicates where this listing should continue from.

listMaskstringOptional

Optional. Can be used to specify which fields of RuntimeMetadata you wish to return in the response. If left empty all fields will be returned.

deploymentTypestring · enumOptionalPossible values:
Responses
get
/model/metadata/runtime

Update a Model Metadata entry.

put
/model/metadata
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Body
URIstringOptional

The URI for the storage bucket containing the model, or the URI to the docker image for custom models. It must be a valid URI as defined in RFC 3986, and must not exceed 200 characters.

Example: gs://seldon-models/sklearn/iris
namestringOptional

The name of the model. It must not exceed 200 characters.

Example: Iris Classifier
versionstringOptional

The version of the model. It must not exceed 50 characters.

Default: "v0.0.1"Example: v1.2.3
artifactTypestring · enumOptional

The artifact type of the model. This is the library used to develop the model.

Default: UNKNOWNExample: SKLEARNPossible values:
taskTypestringOptional

The task type of the model. It must not exceed 50 characters.

Example: classification
creationTimestring · date-timeOptional

The creation timestamp for the model metadata entry. It is automatically created by the Metadata service and cannot be modified. The timestamp is using the RFC 3339 format/

Example: 2017-01-15T01:30:15.01Z
projectstringOptional

The project that this model belongs to.

Example: project_1
Responses
put
/model/metadata

Create a Model Metadata entry.

post
/model/metadata
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Body
URIstringRequired

The URI for the storage bucket containing the model, or the URI to the docker image for custom models. It must be a valid URI as defined in RFC 3986, and must not exceed 200 characters.

Example: gs://seldon-models/sklearn/iris
namestringOptional

The name of the model. It must not exceed 200 characters.

Example: Iris Classifier
versionstringOptional

The version of the model. It must not exceed 50 characters.

Default: "v0.0.1"Example: v1.2.3
artifactTypestring · enumOptional

The artifact type of the model. This is the library used to develop the model.

Default: UNKNOWNExample: SKLEARNPossible values:
taskTypestringOptional

The task type of the model. It must not exceed 50 characters.

Example: classification
creationTimestring · date-timeOptional

The creation timestamp for the model metadata entry. It is automatically created by the Metadata service and cannot be modified. The timestamp is using the RFC 3339 format/

Example: 2017-01-15T01:30:15.01Z
projectstringOptional

The project that this model belongs to.

Example: project_1
Responses
post
/model/metadata

Delete a Model Metadata entry.

delete
/model/metadata
Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Query parameters
URIstringRequired

The URI for the storage bucket containing the model, or the URI to the docker image for custom models. It must be a valid URI as defined in RFC 3986, and must not exceed 200 characters.

projectstringOptional

The project that this model belongs to.

Responses
delete
/model/metadata

List Model Metadata entries.

get
/model/metadata

List takes several parameters that are present in the Model Metadata and tries to list all metadata entries that match all supplied fields. To filter by tags or metrics you can use a map as a query parameter. For example: ?tags[key]=value.

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Query parameters
URIstringOptional
namestringOptional
versionstringOptional
artifactTypestring · enumOptionalPossible values:
taskTypestringOptional
modelTypestringOptional
querystringOptional

For more complex queries where other logical operators like OR, NOT, etc.

pageSizeinteger · int32Optional

Optional. The maximum number of Folders to return in the response.

pageTokenstringOptional

Optional. A pagination token returned from a previous call to List that indicates where this listing should continue from.

listMaskstringOptional

Optional. Can be used to specify which fields of Model you wish to return in the response. If left empty all fields will be returned.

projectstringOptional
orderBystringOptional

Based on https://cloud.google.com/apis/design/design_patterns#sorting_order

The order in which to return the model metadata. The string value should follow SQL syntax: comma separated list of fields. The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. Valid field names include: uri, name, version, project, artifact_type, task_type.

defaultProtocolstring · enumOptionalPossible values:
Responses
get
/model/metadata
get
/version

Read the version

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Responses
get
/version
200

Version

get
/user

Read the request user

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Responses
get
/user
200

User

get
/namespaces/{namespace}/seldondeployments/validate

Validate the given Seldon Deployment

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namespacestringRequired

Namespace provides a logical grouping of resources

Body

+genclient +genclient:noStatus +kubebuilder:object:root=true +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +kubebuilder:storageversion SeldonDeployment is the Schema for the seldondeployments API +k8s:openapi-gen=true +kubebuilder:resource:shortName=sdep +kubebuilder:subresource:status +kubebuilder:subresource:scale:specpath=.spec.replicas,statuspath=.status.replicas

apiVersionstringOptional

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional

kindstringOptional

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional

Responses
get
/namespaces/{namespace}/seldondeployments/validate
get
/namespaces/{namespace}/seldondeployments/{name}/resources

list objects of kind resource for Seldon Deployment

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Query parameters
componentstringOptional

Component differentiates between types of model (e.g. predictor, explainer... etc)

Responses
get
/namespaces/{namespace}/seldondeployments/{name}/resources
post
/namespaces/{namespace}/seldondeployments/{name}/predictfile

Create Seldon Deployment prediction

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Body
predictFilestringRequired

PredictionFile

Responses
post
/namespaces/{namespace}/seldondeployments/{name}/predictfile

No content

put
/namespaces/{namespace}/seldondeployments/{name}/predictcurl

Read the specified Seldon Deployment predict curl

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Body
anyOptional
Responses
put
/namespaces/{namespace}/seldondeployments/{name}/predictcurl

No content

post
/namespaces/{namespace}/seldondeployments/{name}/predict

Create Seldon Deployment prediction

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Body
anyOptional
Responses
post
/namespaces/{namespace}/seldondeployments/{name}/predict

No content

get
/namespaces/{namespace}/seldondeployments/{name}/monitor/outlier-detector/{detectorName}

Read the specified Seldon Deployment Outlier Detector

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

detectorNamestringRequired

Detector Name

Responses
get
/namespaces/{namespace}/seldondeployments/{name}/monitor/outlier-detector/{detectorName}
delete
/namespaces/{namespace}/seldondeployments/{name}/monitor/outlier-detector/{detectorName}

Read the specified Seldon Deployment Outlier Detector

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

detectorNamestringRequired

Detector Name

Responses
delete
/namespaces/{namespace}/seldondeployments/{name}/monitor/outlier-detector/{detectorName}
post
/namespaces/{namespace}/seldondeployments/{name}/monitor/outlier-detector

Create the specified Seldon Deployment Outlier Detector

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Body
namestringOptional
Responses
post
/namespaces/{namespace}/seldondeployments/{name}/monitor/outlier-detector
get
/namespaces/{namespace}/seldondeployments/{name}/monitor/outlier-detector

Read the specified Seldon Deployment Outlier Detector

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Responses
get
/namespaces/{namespace}/seldondeployments/{name}/monitor/outlier-detector
get
/namespaces/{namespace}/seldondeployments/{name}/monitor/metrics-server/{detectorName}

Read the specified Seldon Deployment Metrics Server

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

detectorNamestringRequired

Detector Name

Responses
get
/namespaces/{namespace}/seldondeployments/{name}/monitor/metrics-server/{detectorName}
delete
/namespaces/{namespace}/seldondeployments/{name}/monitor/metrics-server/{detectorName}

Read the specified Seldon Deployment Metrics Server

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

detectorNamestringRequired

Detector Name

Responses
delete
/namespaces/{namespace}/seldondeployments/{name}/monitor/metrics-server/{detectorName}
post
/namespaces/{namespace}/seldondeployments/{name}/monitor/metrics-server

Create the specified Seldon Deployment Metrics Server

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Body
namestringOptional
Responses
post
/namespaces/{namespace}/seldondeployments/{name}/monitor/metrics-server
get
/namespaces/{namespace}/seldondeployments/{name}/monitor/metrics-server

Read the specified Seldon Deployment Metrics Server

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Responses
get
/namespaces/{namespace}/seldondeployments/{name}/monitor/metrics-server
post
/namespaces/{namespace}/seldondeployments/{name}/monitor/featurestatistics

Get the specified Seldon Deployment predictions feature statistics

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Body

DeploymentFeatureData represents a deployment level feature data

aggregate_over_timebooleanOptional

AggregateOverTime is a boolean to decide if the distribution response is to be aggregated over the time period selected

deployment_endpointstringOptional

DeploymentEndpoint refers to endpoint/predictor name relevant to the feature distribution query

deployment_kindstringOptional

DeploymentType refers to kubernetes kind of the deployment relevant to the feature distribution query

deployment_namestringOptional

DeploymentName refers to name of the deployment relevant to the feature distribution query

deployment_namespacestringOptional

DeploymentNamespace refers to namespace of the deployment relevant to the feature distribution query

deployment_nodestringOptional

DeploymentNode refers to node name relevant to the feature distribution query

featurestringOptional

FeatureName refers to the name of feature as per the model predictions schema

interactionstringOptional

Feature Prediction Interaction

reference_databooleanOptional

ReferenceData is a boolean to compute stats and distributions over reference data or inference data (false by default)

Responses
post
/namespaces/{namespace}/seldondeployments/{name}/monitor/featurestatistics
post
/namespaces/{namespace}/seldondeployments/{name}/monitor/featuredistributions

Get the specified Seldon Deployment predictions feature distribution

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Body

DeploymentFeatureData represents a deployment level feature data

aggregate_over_timebooleanOptional

AggregateOverTime is a boolean to decide if the distribution response is to be aggregated over the time period selected

deployment_endpointstringOptional

DeploymentEndpoint refers to endpoint/predictor name relevant to the feature distribution query

deployment_kindstringOptional

DeploymentType refers to kubernetes kind of the deployment relevant to the feature distribution query

deployment_namestringOptional

DeploymentName refers to name of the deployment relevant to the feature distribution query

deployment_namespacestringOptional

DeploymentNamespace refers to namespace of the deployment relevant to the feature distribution query

deployment_nodestringOptional

DeploymentNode refers to node name relevant to the feature distribution query

featurestringOptional

FeatureName refers to the name of feature as per the model predictions schema

interactionstringOptional

Feature Prediction Interaction

reference_databooleanOptional

ReferenceData is a boolean to compute stats and distributions over reference data or inference data (false by default)

Responses
post
/namespaces/{namespace}/seldondeployments/{name}/monitor/featuredistributions
get
/namespaces/{namespace}/seldondeployments/{name}/monitor/drift-detector/{detectorName}

Read the specified Seldon Deployment Drift Detector

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

detectorNamestringRequired

Detector Name

Responses
get
/namespaces/{namespace}/seldondeployments/{name}/monitor/drift-detector/{detectorName}
delete
/namespaces/{namespace}/seldondeployments/{name}/monitor/drift-detector/{detectorName}

Read the specified Seldon Deployment Drift Detector

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

detectorNamestringRequired

Detector Name

Responses
delete
/namespaces/{namespace}/seldondeployments/{name}/monitor/drift-detector/{detectorName}
post
/namespaces/{namespace}/seldondeployments/{name}/monitor/drift-detector

Create the specified Seldon Deployment Drift Detector

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Body
namestringOptional
Responses
post
/namespaces/{namespace}/seldondeployments/{name}/monitor/drift-detector
get
/namespaces/{namespace}/seldondeployments/{name}/monitor/drift-detector

Read the specified Seldon Deployment Drift Detector

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Responses
get
/namespaces/{namespace}/seldondeployments/{name}/monitor/drift-detector
delete
/namespaces/{namespace}/seldondeployments/{name}/loadtestjobs/{jobName}

Delete Seldon Deployment load test jobs

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
jobNamestringRequired

JobName identifies a job name

namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Responses
delete
/namespaces/{namespace}/seldondeployments/{name}/loadtestjobs/{jobName}
post
/namespaces/{namespace}/seldondeployments/{name}/loadtestjobs

Create Seldon Deployment load test

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Body
loadFilestringRequired

Prediction contains predict payload

connectionsNumberstringOptional

Connections Number provides number of allowed connections

requestsNumberstringOptional

Requests Number provides number of allowed requests

durationstringOptional

Duration of load test in seconds

Responses
post
/namespaces/{namespace}/seldondeployments/{name}/loadtestjobs
get
/namespaces/{namespace}/seldondeployments/{name}/loadtestjobs

List Seldon Deployment load test jobs

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Responses
get
/namespaces/{namespace}/seldondeployments/{name}/loadtestjobs
post
/namespaces/{namespace}/seldondeployments/{name}/gitrevert

Revert the git commit

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Query parameters
hashstringOptional

Hash

actionstringOptional

Action

messagestringOptional

Message

Responses
post
/namespaces/{namespace}/seldondeployments/{name}/gitrevert
post
/namespaces/{namespace}/seldondeployments/{name}/gitrestore

Restore the git commit

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Query parameters
hashstringOptional

Hash

actionstringOptional

Action

messagestringOptional

Message

Responses
post
/namespaces/{namespace}/seldondeployments/{name}/gitrestore
get
/namespaces/{namespace}/seldondeployments/{name}/gitlogs

Read the git commits for a Seldon deployment

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Responses
get
/namespaces/{namespace}/seldondeployments/{name}/gitlogs
get
/namespaces/{namespace}/seldondeployments/{name}/gitdiff

Read the git diff for a Seldon deployment

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Query parameters
hashstringOptional

Hash

Responses
get
/namespaces/{namespace}/seldondeployments/{name}/gitdiff
post
/namespaces/{namespace}/seldondeployments/{name}/explain

Create Seldon Deployment explanation

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namespacestringRequired

Namespace provides a logical grouping of resources

namestringRequired

Name identifies a resource

Body
anyOptional
Responses
post
/namespaces/{namespace}/seldondeployments/{name}/explain

No content

get
/namespaces/{namespace}/seldondeployments/{name}/batchjobs/{jobName}

Get details on the seldondeployment's batch job

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

jobNamestringRequired

JobName identifies a job name

Responses
get
/namespaces/{namespace}/seldondeployments/{name}/batchjobs/{jobName}
post
/namespaces/{namespace}/seldondeployments/{name}/batchjobs

Create the seldondeployment's batch jobs

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Body

BatchJobDefinition is a common interface for BatchJob v1 and v2 which specifies necessary arguments

batchDataTypestringOptional

Batch Data Type (data, json or str)

batchIntervalnumber · doubleOptional

Interval between batches

batchMethodstringOptional

Batch Method (predict, feedback (for SCv1))

batchPayloadTypestringOptional

Batch Payload Type (ndarray, tensor, tftensor, v2raw, v2binary - only if DataType=data)

batchRetriesinteger · int64Optional

Number of retries for each instance

batchSizeinteger · int64Optional

Size of the batch (number of predictions per request)

batchTransportProtocolstringOptional

Batch Transport Protocol (rest or grpc)

batchWorkersinteger · int64Optional

Number of batch workers

inputDatastringOptional

S3 URI of input data file

limitsCpustringOptional

Container Resources for running batch jobs: limits: CPU

limitsMemorystringOptional

Container Resources for running batch jobs: limits: Memory

objectStoreSecretNamestringOptional

name of Kubernetes Secret with S3 credentials

outputDatastringOptional

S3 URI of output data file

pvcSizestringOptional

Size of PVC required for the batch job

requestsCpustringOptional

Container Resources for running batch jobs: requests: CPU

requestsMemorystringOptional

Container Resources for running batch jobs: requests: Memory

Responses
post
/namespaces/{namespace}/seldondeployments/{name}/batchjobs
get
/namespaces/{namespace}/seldondeployments/{name}/batchjobs

Read the seldondeployment's batch jobs

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Query parameters
limitstringOptional

Limit of items returned in one response

PagestringOptional

Requested page

Responses
get
/namespaces/{namespace}/seldondeployments/{name}/batchjobs
put
/namespaces/{namespace}/seldondeployments/{name}

Update the specified Seldon Deployment

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Query parameters
actionstringOptional

Action

messagestringOptional

Message

Body

+genclient +genclient:noStatus +kubebuilder:object:root=true +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +kubebuilder:storageversion SeldonDeployment is the Schema for the seldondeployments API +k8s:openapi-gen=true +kubebuilder:resource:shortName=sdep +kubebuilder:subresource:status +kubebuilder:subresource:scale:specpath=.spec.replicas,statuspath=.status.replicas

apiVersionstringOptional

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional

kindstringOptional

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional

Responses
put
/namespaces/{namespace}/seldondeployments/{name}
get
/namespaces/{namespace}/seldondeployments/{name}

Read the specified Seldon Deployment

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Responses
get
/namespaces/{namespace}/seldondeployments/{name}
delete
/namespaces/{namespace}/seldondeployments/{name}

Delete the specified Seldon Deployment

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Query parameters
actionstringOptional

Action

messagestringOptional

Message

Responses
delete
/namespaces/{namespace}/seldondeployments/{name}

No content

post
/namespaces/{namespace}/seldondeployments

Create a Seldon Deployment

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namespacestringRequired

Namespace provides a logical grouping of resources

Query parameters
actionstringOptional

Action

messagestringOptional

Message

Body

+genclient +genclient:noStatus +kubebuilder:object:root=true +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +kubebuilder:storageversion SeldonDeployment is the Schema for the seldondeployments API +k8s:openapi-gen=true +kubebuilder:resource:shortName=sdep +kubebuilder:subresource:status +kubebuilder:subresource:scale:specpath=.spec.replicas,statuspath=.status.replicas

apiVersionstringOptional

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional

kindstringOptional

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional

Responses
post
/namespaces/{namespace}/seldondeployments
get
/namespaces/{namespace}/seldondeployments

list objects of kind Seldon Deployment

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namespacestringRequired

Namespace provides a logical grouping of resources

Responses
get
/namespaces/{namespace}/seldondeployments
post
/namespaces/{namespace}/pipelines/{name}/predictfile

Create Seldon Pipeline prediction

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Body
predictFilestringRequired

PredictionFile

Responses
post
/namespaces/{namespace}/pipelines/{name}/predictfile

No content

put
/namespaces/{namespace}/pipelines/{name}/predictcurl

Read the specified Seldon Pipeline predict curl

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Body
anyOptional
Responses
put
/namespaces/{namespace}/pipelines/{name}/predictcurl

No content

get
/namespaces/{namespace}/pipelines/{name}/monitor/outlier-detector/{detectorName}

Read the specified Seldon Pipeline Outlier Detector

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

detectorNamestringRequired

Detector Name

Responses
get
/namespaces/{namespace}/pipelines/{name}/monitor/outlier-detector/{detectorName}
delete
/namespaces/{namespace}/pipelines/{name}/monitor/outlier-detector/{detectorName}

Read the specified Seldon Pipeline Outlier Detector

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

detectorNamestringRequired

Detector Name

Responses
delete
/namespaces/{namespace}/pipelines/{name}/monitor/outlier-detector/{detectorName}
post
/namespaces/{namespace}/pipelines/{name}/monitor/outlier-detector

Create the specified Seldon Pipeline Outlier Detector

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Body
namestringOptional
Responses
post
/namespaces/{namespace}/pipelines/{name}/monitor/outlier-detector
get
/namespaces/{namespace}/pipelines/{name}/monitor/outlier-detector

List the specified Seldon Pipeline Outlier Detector

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Responses
get
/namespaces/{namespace}/pipelines/{name}/monitor/outlier-detector
post
/namespaces/{namespace}/pipelines/{name}/monitor/featurestatistics

Get the specified Seldon Deployment predictions feature statistics

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Body

DeploymentFeatureData represents a deployment level feature data

aggregate_over_timebooleanOptional

AggregateOverTime is a boolean to decide if the distribution response is to be aggregated over the time period selected

deployment_endpointstringOptional

DeploymentEndpoint refers to endpoint/predictor name relevant to the feature distribution query

deployment_kindstringOptional

DeploymentType refers to kubernetes kind of the deployment relevant to the feature distribution query

deployment_namestringOptional

DeploymentName refers to name of the deployment relevant to the feature distribution query

deployment_namespacestringOptional

DeploymentNamespace refers to namespace of the deployment relevant to the feature distribution query

deployment_nodestringOptional

DeploymentNode refers to node name relevant to the feature distribution query

featurestringOptional

FeatureName refers to the name of feature as per the model predictions schema

interactionstringOptional

Feature Prediction Interaction

reference_databooleanOptional

ReferenceData is a boolean to compute stats and distributions over reference data or inference data (false by default)

Responses
post
/namespaces/{namespace}/pipelines/{name}/monitor/featurestatistics
post
/namespaces/{namespace}/pipelines/{name}/monitor/featuredistributions

Get the specified Seldon Deployment predictions feature distribution

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Body

DeploymentFeatureData represents a deployment level feature data

aggregate_over_timebooleanOptional

AggregateOverTime is a boolean to decide if the distribution response is to be aggregated over the time period selected

deployment_endpointstringOptional

DeploymentEndpoint refers to endpoint/predictor name relevant to the feature distribution query

deployment_kindstringOptional

DeploymentType refers to kubernetes kind of the deployment relevant to the feature distribution query

deployment_namestringOptional

DeploymentName refers to name of the deployment relevant to the feature distribution query

deployment_namespacestringOptional

DeploymentNamespace refers to namespace of the deployment relevant to the feature distribution query

deployment_nodestringOptional

DeploymentNode refers to node name relevant to the feature distribution query

featurestringOptional

FeatureName refers to the name of feature as per the model predictions schema

interactionstringOptional

Feature Prediction Interaction

reference_databooleanOptional

ReferenceData is a boolean to compute stats and distributions over reference data or inference data (false by default)

Responses
post
/namespaces/{namespace}/pipelines/{name}/monitor/featuredistributions
get
/namespaces/{namespace}/pipelines/{name}/monitor/drift-detector/{detectorName}

Read the specified Seldon Pipeline Drift Detector

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

detectorNamestringRequired

Detector Name

Responses
get
/namespaces/{namespace}/pipelines/{name}/monitor/drift-detector/{detectorName}
delete
/namespaces/{namespace}/pipelines/{name}/monitor/drift-detector/{detectorName}

Read the specified Seldon Pipeline Drift Detector

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

detectorNamestringRequired

Detector Name

Responses
delete
/namespaces/{namespace}/pipelines/{name}/monitor/drift-detector/{detectorName}
post
/namespaces/{namespace}/pipelines/{name}/monitor/drift-detector

Create the specified Seldon Pipeline Drift Detector

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Body
namestringOptional
Responses
post
/namespaces/{namespace}/pipelines/{name}/monitor/drift-detector
get
/namespaces/{namespace}/pipelines/{name}/monitor/drift-detector

List the specified Seldon Pipeline Drift Detector

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Responses
get
/namespaces/{namespace}/pipelines/{name}/monitor/drift-detector
get
/namespaces/{namespace}/pipelines/{name}/models

List objects of kind Seldon Models within a Pipeline

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Responses
get
/namespaces/{namespace}/pipelines/{name}/models
delete
/namespaces/{namespace}/pipelines/{name}/loadtestjobs/{jobName}

Delete Pipeline load test jobs

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
jobNamestringRequired

JobName identifies a job name

namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Responses
delete
/namespaces/{namespace}/pipelines/{name}/loadtestjobs/{jobName}
post
/namespaces/{namespace}/pipelines/{name}/loadtestjobs

Create Pipeline load test

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Body
loadFilestringRequired

Prediction contains predict payload

connectionsNumberstringOptional

Connections Number provides number of allowed connections

requestsNumberstringOptional

Requests Number provides number of allowed requests

durationstringOptional

Duration of load test in seconds

Responses
post
/namespaces/{namespace}/pipelines/{name}/loadtestjobs
get
/namespaces/{namespace}/pipelines/{name}/loadtestjobs

List Pipeline load test jobs

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Responses
get
/namespaces/{namespace}/pipelines/{name}/loadtestjobs
get
/namespaces/{namespace}/pipelines/{name}/gitlogs

Read the git commits for a pipeline

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Responses
get
/namespaces/{namespace}/pipelines/{name}/gitlogs
get
/namespaces/{namespace}/pipelines/{name}/gitdiff

Read the git diff for a pipeline

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Query parameters
hashstringOptional

Hash

Responses
get
/namespaces/{namespace}/pipelines/{name}/gitdiff
put
/namespaces/{namespace}/pipelines/{name}/explainer

Update the specified Seldon Pipeline Explainer

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Query parameters
actionstringOptional

Action

messagestringOptional

Message

Body

Model is the Schema for the models API

apiVersionstringOptional

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional

creationTimestampstringOptional

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

deletionGracePeriodSecondsinteger · int64Optional

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional

deletionTimestampstringOptional

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

finalizersstring[]Optional

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. +optional +patchStrategy=merge

generateNamestringOptional

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional

generationinteger · int64Optional

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional

kindstringOptional

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional

namestringOptional

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names +optional

namespacestringOptional

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces +optional

resourceVersionstringOptional

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional

selfLinkstringOptional

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional

uidstringOptional

UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated.

Responses
put
/namespaces/{namespace}/pipelines/{name}/explainer
post
/namespaces/{namespace}/pipelines/{name}/explainer

Read the specified Seldon Pipeline Explainer

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Query parameters
actionstringOptional

Action

messagestringOptional

Message

Body

Model is the Schema for the models API

apiVersionstringOptional

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional

creationTimestampstringOptional

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

deletionGracePeriodSecondsinteger · int64Optional

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional

deletionTimestampstringOptional

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

finalizersstring[]Optional

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. +optional +patchStrategy=merge

generateNamestringOptional

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional

generationinteger · int64Optional

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional

kindstringOptional

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional

namestringOptional

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names +optional

namespacestringOptional

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces +optional

resourceVersionstringOptional

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional

selfLinkstringOptional

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional

uidstringOptional

UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated.

Responses
post
/namespaces/{namespace}/pipelines/{name}/explainer
get
/namespaces/{namespace}/pipelines/{name}/explainer

Read the specified Seldon Pipeline Explainer

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Responses
get
/namespaces/{namespace}/pipelines/{name}/explainer
delete
/namespaces/{namespace}/pipelines/{name}/explainer

Read the specified Seldon Pipeline Explainer

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Query parameters
actionstringOptional

Action

messagestringOptional

Message

Responses
delete
/namespaces/{namespace}/pipelines/{name}/explainer

No content

post
/namespaces/{namespace}/pipelines/{name}/explain

Create Seldon Pipeline explanation

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namespacestringRequired

Namespace provides a logical grouping of resources

namestringRequired

Name identifies a resource

Body
anyOptional
Responses
post
/namespaces/{namespace}/pipelines/{name}/explain

No content

put
/namespaces/{namespace}/pipelines/{name}/experiment/shadow

Promote the specified Seldon Pipeline Shadow

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Query parameters
actionstringOptional

Action

messagestringOptional

Message

Responses
put
/namespaces/{namespace}/pipelines/{name}/experiment/shadow

No content

post
/namespaces/{namespace}/pipelines/{name}/experiment/shadow

Create the specified Seldon Pipeline Shadow experiment

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Query parameters
actionstringOptional

Action

messagestringOptional

Message

Responses
post
/namespaces/{namespace}/pipelines/{name}/experiment/shadow

No content

delete
/namespaces/{namespace}/pipelines/{name}/experiment/shadow

Delete the specified Seldon Pipeline Shadow

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Query parameters
actionstringOptional

Action

messagestringOptional

Message

Responses
delete
/namespaces/{namespace}/pipelines/{name}/experiment/shadow

No content

put
/namespaces/{namespace}/pipelines/{name}/experiment/canary

Promote the specified Seldon Pipeline Canary

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Query parameters
actionstringOptional

Action

messagestringOptional

Message

Responses
put
/namespaces/{namespace}/pipelines/{name}/experiment/canary

No content

post
/namespaces/{namespace}/pipelines/{name}/experiment/canary

Create the specified Seldon Pipeline Canary experiment

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Query parameters
actionstringOptional

Action

messagestringOptional

Message

weightinteger · int64Required

Weight of the traffic directed to the canary pipeline, between 0 and 100

Responses
post
/namespaces/{namespace}/pipelines/{name}/experiment/canary

No content

delete
/namespaces/{namespace}/pipelines/{name}/experiment/canary

Delete the specified Seldon Pipeline Canary

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Query parameters
actionstringOptional

Action

messagestringOptional

Message

Responses
delete
/namespaces/{namespace}/pipelines/{name}/experiment/canary

No content

put
/namespaces/{namespace}/pipelines/{name}/experiment

Update the specified Seldon Pipeline Experiment

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Query parameters
actionstringOptional

Action

messagestringOptional

Message

Body

Experiment is the Schema for the experiments API

apiVersionstringOptional

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional

creationTimestampstringOptional

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

deletionGracePeriodSecondsinteger · int64Optional

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional

deletionTimestampstringOptional

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

finalizersstring[]Optional

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. +optional +patchStrategy=merge

generateNamestringOptional

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional

generationinteger · int64Optional

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional

kindstringOptional

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional

namestringOptional

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names +optional

namespacestringOptional

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces +optional

resourceVersionstringOptional

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional

selfLinkstringOptional

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional

uidstringOptional

UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated.

Responses
put
/namespaces/{namespace}/pipelines/{name}/experiment
post
/namespaces/{namespace}/pipelines/{name}/experiment

Create a Seldon Pipeline Experiment

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Query parameters
actionstringOptional

Action

messagestringOptional

Message

Body

Experiment is the Schema for the experiments API

apiVersionstringOptional

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional

creationTimestampstringOptional

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

deletionGracePeriodSecondsinteger · int64Optional

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional

deletionTimestampstringOptional

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

finalizersstring[]Optional

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. +optional +patchStrategy=merge

generateNamestringOptional

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional

generationinteger · int64Optional

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional

kindstringOptional

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional

namestringOptional

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names +optional

namespacestringOptional

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces +optional

resourceVersionstringOptional

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional

selfLinkstringOptional

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional

uidstringOptional

UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated.

Responses
post
/namespaces/{namespace}/pipelines/{name}/experiment
get
/namespaces/{namespace}/pipelines/{name}/experiment

Read Seldon Pipeline Experiment

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Responses
get
/namespaces/{namespace}/pipelines/{name}/experiment
delete
/namespaces/{namespace}/pipelines/{name}/experiment

Delete Seldon Pipeline Experiment Pipelines

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Responses
delete
/namespaces/{namespace}/pipelines/{name}/experiment

No content

get
/namespaces/{namespace}/pipelines/{name}/batchjobs/{jobName}

Get details on the pipeline batch job

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

jobNamestringRequired

JobName identifies a job name

Responses
get
/namespaces/{namespace}/pipelines/{name}/batchjobs/{jobName}
post
/namespaces/{namespace}/pipelines/{name}/batchjobs

Create the pipeline batch jobs

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Body

BatchJobDefinition is a common interface for BatchJob v1 and v2 which specifies necessary arguments

batchDataTypestringOptional

Batch Data Type (data, json or str)

batchIntervalnumber · doubleOptional

Interval between batches

batchMethodstringOptional

Batch Method (predict, feedback (for SCv1))

batchPayloadTypestringOptional

Batch Payload Type (ndarray, tensor, tftensor, v2raw, v2binary - only if DataType=data)

batchRetriesinteger · int64Optional

Number of retries for each instance

batchSizeinteger · int64Optional

Size of the batch (number of predictions per request)

batchTransportProtocolstringOptional

Batch Transport Protocol (rest or grpc)

batchWorkersinteger · int64Optional

Number of batch workers

inputDatastringOptional

S3 URI of input data file

limitsCpustringOptional

Container Resources for running batch jobs: limits: CPU

limitsMemorystringOptional

Container Resources for running batch jobs: limits: Memory

objectStoreSecretNamestringOptional

name of Kubernetes Secret with S3 credentials

outputDatastringOptional

S3 URI of output data file

pvcSizestringOptional

Size of PVC required for the batch job

requestsCpustringOptional

Container Resources for running batch jobs: requests: CPU

requestsMemorystringOptional

Container Resources for running batch jobs: requests: Memory

Responses
post
/namespaces/{namespace}/pipelines/{name}/batchjobs
get
/namespaces/{namespace}/pipelines/{name}/batchjobs

Read the pipeline batch jobs

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Query parameters
limitstringOptional

Limit of items returned in one response

PagestringOptional

Requested page

Responses
get
/namespaces/{namespace}/pipelines/{name}/batchjobs
put
/namespaces/{namespace}/pipelines/{name}

Update the specified Seldon Pipeline

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Query parameters
actionstringOptional

Action

messagestringOptional

Message

Body

Pipeline is the Schema for the pipelines API

apiVersionstringOptional

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional

creationTimestampstringOptional

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

deletionGracePeriodSecondsinteger · int64Optional

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional

deletionTimestampstringOptional

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

finalizersstring[]Optional

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. +optional +patchStrategy=merge

generateNamestringOptional

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional

generationinteger · int64Optional

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional

kindstringOptional

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional

namestringOptional

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names +optional

namespacestringOptional

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces +optional

resourceVersionstringOptional

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional

selfLinkstringOptional

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional

uidstringOptional

UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated.

Responses
put
/namespaces/{namespace}/pipelines/{name}
get
/namespaces/{namespace}/pipelines/{name}

Read the specified Seldon Pipeline

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Responses
get
/namespaces/{namespace}/pipelines/{name}
delete
/namespaces/{namespace}/pipelines/{name}

Delete the specified Seldon Pipeline

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Query parameters
actionstringOptional

Action

messagestringOptional

Message

Responses
delete
/namespaces/{namespace}/pipelines/{name}

No content

post
/namespaces/{namespace}/pipelines

Create a Seldon Pipeline

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namespacestringRequired

Namespace provides a logical grouping of resources

Query parameters
actionstringOptional

Action

messagestringOptional

Message

Body

Pipeline is the Schema for the pipelines API

apiVersionstringOptional

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional

creationTimestampstringOptional

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

deletionGracePeriodSecondsinteger · int64Optional

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional

deletionTimestampstringOptional

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

finalizersstring[]Optional

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. +optional +patchStrategy=merge

generateNamestringOptional

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional

generationinteger · int64Optional

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional

kindstringOptional

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional

namestringOptional

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names +optional

namespacestringOptional

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces +optional

resourceVersionstringOptional

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional

selfLinkstringOptional

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional

uidstringOptional

UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated.

Responses
post
/namespaces/{namespace}/pipelines
get
/namespaces/{namespace}/pipelines

list objects of kind Seldon Pipelines

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namespacestringRequired

Namespace provides a logical grouping of resources

Responses
get
/namespaces/{namespace}/pipelines
get
/namespaces/{namespace}/models/{name}/gitlogs

Read the git commits for a model

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Responses
get
/namespaces/{namespace}/models/{name}/gitlogs
get
/namespaces/{namespace}/models/{name}/gitdiff

Read the git diff for a model

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Query parameters
hashstringOptional

Hash

Responses
get
/namespaces/{namespace}/models/{name}/gitdiff
put
/namespaces/{namespace}/models/{name}

Update the specified Seldon Model

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Query parameters
actionstringOptional

Action

messagestringOptional

Message

Body

Model is the Schema for the models API

apiVersionstringOptional

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional

creationTimestampstringOptional

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

deletionGracePeriodSecondsinteger · int64Optional

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional

deletionTimestampstringOptional

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

finalizersstring[]Optional

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. +optional +patchStrategy=merge

generateNamestringOptional

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional

generationinteger · int64Optional

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional

kindstringOptional

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional

namestringOptional

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names +optional

namespacestringOptional

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces +optional

resourceVersionstringOptional

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional

selfLinkstringOptional

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional

uidstringOptional

UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated.

Responses
put
/namespaces/{namespace}/models/{name}
get
/namespaces/{namespace}/models/{name}

Read the specified Seldon Model

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Responses
get
/namespaces/{namespace}/models/{name}
delete
/namespaces/{namespace}/models/{name}

Delete the specified Seldon Model

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namestringRequired

Name identifies a resource

namespacestringRequired

Namespace provides a logical grouping of resources

Query parameters
actionstringOptional

Action

messagestringOptional

Message

Responses
delete
/namespaces/{namespace}/models/{name}

No content

post
/namespaces/{namespace}/models

Create a Seldon Model

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namespacestringRequired

Namespace provides a logical grouping of resources

Query parameters
actionstringOptional

Action

messagestringOptional

Message

Body

Model is the Schema for the models API

apiVersionstringOptional

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional

creationTimestampstringOptional

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

deletionGracePeriodSecondsinteger · int64Optional

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional

deletionTimestampstringOptional

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

finalizersstring[]Optional

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. +optional +patchStrategy=merge

generateNamestringOptional

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional

generationinteger · int64Optional

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional

kindstringOptional

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional

namestringOptional

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names +optional

namespacestringOptional

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces +optional

resourceVersionstringOptional

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional

selfLinkstringOptional

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional

uidstringOptional

UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated.

Responses
post
/namespaces/{namespace}/models
get
/namespaces/{namespace}/gitops-status

Read the GitOps status

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namespacestringRequired

Namespace provides a logical grouping of resources

Responses
get
/namespaces/{namespace}/gitops-status
200

Generic

No content

get
/namespaces/{namespace}/gitdiffs

Read the git diffs from hashes

Authorizations
OAuth2passwordRequired
Token URL:
Available scopes:
Path parameters
namespacestringRequired

Namespace provides a logical grouping of resources

Query parameters
hashesstring[]Required

Hashes is an array of git commit hashes to get diffs for

Responses
get
/namespaces/{namespace}/gitdiffs

Last updated

Was this helpful?