/api/stations/v1/interfaces/{interfaceId}
- 22 Aug 2024
- 7 Minutes to read
- Contributors
- Print
/api/stations/v1/interfaces/{interfaceId}
- Updated on 22 Aug 2024
- 7 Minutes to read
- Contributors
- Print
Article summary
Did you find this summary helpful?
Thank you for your feedback
Patch
/api/stations/v1/interfaces/{interfaceId}
Updates an interface.
Path parameters
interfaceId
Required
The id of the interface to update.
Exampleg56RCoZCtzv7borvp
Body parameters
The fields to update for the interface.
object
Used to update an interface.
name
string
The name of the interface.
Max length500
Responses
200
The interface was updated successfully.
object
Represents an interface.
Example{ "id": "swM2aGebq5MjhKafN", "name": "iPad 5", "type": "computer", "stationId": "78M2aGebq5MjhKafN", "registration": { "status": "pending", "mode": "link", "link": { "player": "http://acme.tulip.co/open-player?tulip-player=eyJhY3Rpb24iOiJyZWdpc3RlclVzaW5nUmVnaXM0cmF0aW9uSWRl", "browser": "http://acme.tulip.co/w/DEFAULT/player?registrationIdentifier=Ak72m5fU6_o1E16ARx-ewh-5x2CmmfBLoBkk0KFcUBI" } }, "onlineStatus": { "isOnline": false }, "created": { "at": "2023-03-08T12:17:24Z", "by": { "id": "90M2aGebq5MjhKafN", "type": "user" } }, "workspaces": { "scope": "specific", "workspaceIds": [ "56M2aGebq5MjhKafN" ] } }
id
Exampleg56RCoZCtzv7borvp
name
string
The name of the interface.
type
string
The type of the interface.
Valid values[ "computer", "mobile" ]
stationId
Exampleg56RCoZCtzv7borvp
registration
object (InterfaceRegistration)
The registration information for the interface.
status
string
The status of this registration.
Valid values[ "pending", "registered" ]
mode
string
The mode of this registration.
Valid values[ "manual", "link" ]
token
object
The token used to register the interface. The presence of this field will depend on user privileges.
value
string
The value of the token.
isActive
boolean
Flag indicating whether the token is active.
isAutoGenerated
boolean
Flag indicating whether the token was auto-generated.
link
object
The link used to register the interface.
player
string
Registration link to be used in player.
browser
string
Registration link to be used in browser.
clientInfo
object (InterfaceClientInfo)
The client information for the interface.
platform
string
The client's platform.
playerVersion
string
The Tulip player version for this client.
releaseChannel
string
The client's release channel.
deviceInfo
object
Information about the physical device or hardware running the Player application.
os
string
The operating system name.
osVersion
string
The operating system version.
osBuild
string
The operating system build number.
manufacturer
string
Manufacturer name.
model
string
Model name.
hardwareSerialNumber
string
Hardware serial number.
onlineStatus
object (OnlineStatus)
The online status for the interface.
isOnline
boolean
Flag indicating whether the interface is online.
lastSeen
Example2022-11-21T07:59:10Z
lastSessionStart
Example2022-11-21T07:59:10Z
created
by
object (ActorMetadata)
Represents a user, api-token, or device.
type
string
Valid values[ "user", "api-token", "device" ]
id
Exampleg56RCoZCtzv7borvp
lastModified
by
object (ActorMetadata)
Represents a user, api-token, or device.
type
string
Valid values[ "user", "api-token", "device" ]
id
Exampleg56RCoZCtzv7borvp
archived
by
object (ActorMetadata)
Represents a user, api-token, or device.
type
string
Valid values[ "user", "api-token", "device" ]
id
Exampleg56RCoZCtzv7borvp
workspaces
object (WorkspaceMembership)
A description of the workspaces of which a resource is a member. Workspace membership can have one of two scope values. A scope of all means that a resource is a member of all current and future workspaces. A scope of the value specific means that a resource is a member of a set of particular workspaces as described by the workspaceIds property.
Example{ "scope": "specific", "workspaceIds": [ "DEFAULT" ] }
OneOf
AllWorkspacesMembership
scope
string
Describes a resource as a member of all current and future workspaces.
Valid values[ "all" ]
Exampleall
SpecificWorkspacesMembership
scope
string
Describes a resource as a member of a set of specific workspaces.
Valid values[ "specific" ]
Examplespecific
workspaceIds
Array of string (WorkspaceId)
The workspaces in which a resource is a member.
string
ExampleDEFAULT
400
An error occurred. The Tulip error codes generic.customerIdRequired, generic.workspaceIdRequired, generic.invalidParams, http.invalidBodyJson, http.invalidHeaders, and http.multiValueHeader all use the 400 HTTP status code. See the documentation of the response content schema for details on these specific Tulip errors that could result in this status code.
OneOf
object
errorCode
string
A machine-readable code identifying the type of error.
Pattern^[a-zA-Z0-9.]$
message
string
A human-readable description of the error intended for debugging purposes only.
The exact content of this message is not stable.
retryable
boolean
Whether the request can be automatically retried by the client.
errorCode
Valid values[ "generic.customerIdRequired" ]
retryable
Valid values[ "False" ]
object
errorCode
string
A machine-readable code identifying the type of error.
Pattern^[a-zA-Z0-9.]$
message
string
A human-readable description of the error intended for debugging purposes only.
The exact content of this message is not stable.
retryable
boolean
Whether the request can be automatically retried by the client.
errorCode
Valid values[ "generic.workspaceIdRequired" ]
retryable
Valid values[ "False" ]
object
errorCode
string
A machine-readable code identifying the type of error.
Pattern^[a-zA-Z0-9.]$
message
string
A human-readable description of the error intended for debugging purposes only.
The exact content of this message is not stable.
retryable
boolean
Whether the request can be automatically retried by the client.
errorCode
Valid values[ "generic.invalidParams" ]
retryable
Valid values[ "False" ]
object
errorCode
string
A machine-readable code identifying the type of error.
Pattern^[a-zA-Z0-9.]$
message
string
A human-readable description of the error intended for debugging purposes only.
The exact content of this message is not stable.
retryable
boolean
Whether the request can be automatically retried by the client.
errorCode
Valid values[ "http.invalidBodyJson" ]
retryable
Valid values[ "False" ]
object
errorCode
string
A machine-readable code identifying the type of error.
Pattern^[a-zA-Z0-9.]$
message
string
A human-readable description of the error intended for debugging purposes only.
The exact content of this message is not stable.
retryable
boolean
Whether the request can be automatically retried by the client.
errorCode
Valid values[ "http.invalidHeaders" ]
retryable
Valid values[ "False" ]
object
errorCode
string
A machine-readable code identifying the type of error.
Pattern^[a-zA-Z0-9.]$
message
string
A human-readable description of the error intended for debugging purposes only.
The exact content of this message is not stable.
retryable
boolean
Whether the request can be automatically retried by the client.
errorCode
Valid values[ "http.multiValueHeader" ]
details
object
headerName
string
The name of the given HTTP header which had multiple values.
retryable
Valid values[ "False" ]
401
The request was missing required authentication information.
This error is not automatically retryable.
object
errorCode
string
A machine-readable code identifying the type of error.
Pattern^[a-zA-Z0-9.]$
message
string
A human-readable description of the error intended for debugging purposes only.
The exact content of this message is not stable.
retryable
boolean
Whether the request can be automatically retried by the client.
errorCode
Valid values[ "generic.authRequired" ]
retryable
Valid values[ "False" ]
404
The requested resource was not found.
This error is not automatically retryable.
object
errorCode
string
A machine-readable code identifying the type of error.
Pattern^[a-zA-Z0-9.]$
message
string
A human-readable description of the error intended for debugging purposes only.
The exact content of this message is not stable.
retryable
boolean
Whether the request can be automatically retried by the client.
errorCode
Valid values[ "generic.notFound" ]
retryable
Valid values[ "False" ]
409
Resource with this name already exists in the workspace.
This error is not automatically retryable.
object
errorCode
string
A machine-readable code identifying the type of error.
Pattern^[a-zA-Z0-9.]$
message
string
A human-readable description of the error intended for debugging purposes only.
The exact content of this message is not stable.
retryable
boolean
Whether the request can be automatically retried by the client.
errorCode
Valid values[ "stations.resourceWithThisNameAlreadyExists" ]
details
object
name
string
type
string
retryable
Valid values[ "False" ]
422
An error occurred. The Tulip error codes generic.archivedResourceUnsupportedOperation and stations.invalidResourceName both use the 422 HTTP status code. See the documentation of the response content schema for details on these specific Tulip errors that could result in this status code.
OneOf
object
errorCode
string
A machine-readable code identifying the type of error.
Pattern^[a-zA-Z0-9.]$
message
string
A human-readable description of the error intended for debugging purposes only.
The exact content of this message is not stable.
retryable
boolean
Whether the request can be automatically retried by the client.
errorCode
Valid values[ "generic.archivedResourceUnsupportedOperation" ]
retryable
Valid values[ "False" ]
object
errorCode
string
A machine-readable code identifying the type of error.
Pattern^[a-zA-Z0-9.]$
message
string
A human-readable description of the error intended for debugging purposes only.
The exact content of this message is not stable.
retryable
boolean
Whether the request can be automatically retried by the client.
errorCode
Valid values[ "stations.invalidResourceName" ]
details
object
reason
string
retryable
Valid values[ "False" ]
429
Too many requests have been made to this endpoint in a short time period.
This error is not automatically retryable.
object
errorCode
string
A machine-readable code identifying the type of error.
Pattern^[a-zA-Z0-9.]$
message
string
A human-readable description of the error intended for debugging purposes only.
The exact content of this message is not stable.
retryable
boolean
Whether the request can be automatically retried by the client.
errorCode
Valid values[ "http.endpointRateLimitExceeded" ]
details
object
details
string
Additional details about this endpoint's rate limits.
retryable
Valid values[ "False" ]
500
An error occurred. The Tulip error codes generic.internal and stations.internalTypeValidationError both use the 500 HTTP status code. See the documentation of the response content schema for details on these specific Tulip errors that could result in this status code.
OneOf
object
errorCode
string
A machine-readable code identifying the type of error.
Pattern^[a-zA-Z0-9.]$
message
string
A human-readable description of the error intended for debugging purposes only.
The exact content of this message is not stable.
retryable
boolean
Whether the request can be automatically retried by the client.
errorCode
Valid values[ "generic.internal" ]
retryable
Valid values[ "False" ]
object
errorCode
string
A machine-readable code identifying the type of error.
Pattern^[a-zA-Z0-9.]$
message
string
A human-readable description of the error intended for debugging purposes only.
The exact content of this message is not stable.
retryable
boolean
Whether the request can be automatically retried by the client.
errorCode
Valid values[ "stations.internalTypeValidationError" ]
details
object
resourceName
string
The name of the resource that failed validation.
resourceId
string
The id of the resource that failed validation.
retryable
Valid values[ "False" ]
Was this article helpful?
