--- title: "/api/stations/v1/stations/{stationId}/archive" slug: "apistationsv1stationsstationidarchive" updated: 2024-10-17T20:32:06Z published: 2024-10-17T20:32:06Z --- > ## Documentation Index > Fetch the complete documentation index at: https://support.tulip.co/llms.txt > Use this file to discover all available pages before exploring further. # /api/stations/v1/stations/{stationId}/archive Post/api/stations/v1/stations/{stationId}/archive Archives a station. Restore is not supported at the moment. Path parametersstationIdRequired The id of the station to archive. Exampleg56RCoZCtzv7borvp Responses200 The station was successfully archived. Expand Allobject Represents a station. Example{ "id": "swM2aGebq5MjhKafN", "name": "Boston Line 1", "description": "Station for line 1 at the Boston location.", "stationGroupId": "12M453ebq5MjhKafN", "operatorId": "234M2aGebq5MjhKafN", "timezone": "America/New_York", "appExecutionState": { "stepId": "7psyeGebq5MjhKafN", "appVersionId": "58H1aGebp8DqkPaeV" }, "created": { "at": "2023-03-08T12:17:24Z", "by": { "id": "90M2aGebq5MjhKafN", "type": "user" } }, "lastModified": { "at": "2023-03-08T12:17:24Z", "by": { "id": "90M2aGebq5MjhKafN", "type": "user" } }, "workspaces": { "scope": "specific", "workspaceIds": [ "56M2aGebq5MjhKafN" ] } }idExampleg56RCoZCtzv7borvp namestring The name of the station. descriptionstring A short description of the station. appExecutionStateobject (AppExecutionState) Contains context about a station's current app execution. Example{ "appVersionId": "614M2uGrbq5BjhKrpQ", "stepId": "9834aGebq5MjhKafN" }appVersionIdExampleg56RCoZCtzv7borvp stepIdExampleg56RCoZCtzv7borvp stationGroupIdExampleg56RCoZCtzv7borvp operatorIdExampleg56RCoZCtzv7borvp timezonestring A canonical IANA time zone identifier. ExampleAmerica/New_York createdatstring (date-time) A date-time string as defined by [RFC 3339 §5.6](https://tools.ietf.org/html/rfc3339#section-5.6). Example2022-11-21T07:59:10Z byobject (ActorMetadata) Represents a user, api-token, or device. typestring Valid values[ "user", "client", "api-token", "app-exchange-api-token", "celosx-api-token", "automation", "instance-init" ] idExampleg56RCoZCtzv7borvp lastModifiedatstring (date-time) A date-time string as defined by [RFC 3339 §5.6](https://tools.ietf.org/html/rfc3339#section-5.6). Example2022-11-21T07:59:10Z byobject (ActorMetadata) Represents a user, api-token, or device. typestring Valid values[ "user", "client", "api-token", "app-exchange-api-token", "celosx-api-token", "automation", "instance-init" ] idExampleg56RCoZCtzv7borvp archivedatstring (date-time) A date-time string as defined by [RFC 3339 §5.6](https://tools.ietf.org/html/rfc3339#section-5.6). Example2022-11-21T07:59:10Z byobject (ActorMetadata) Represents a user, api-token, or device. typestring Valid values[ "user", "client", "api-token", "app-exchange-api-token", "celosx-api-token", "automation", "instance-init" ] idExampleg56RCoZCtzv7borvp workspacesobject (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" ] }#content#OneOfAllWorkspacesMembershipscopestring Describes a resource as a member of all current and future workspaces. Valid values[ "all" ]Exampleall SpecificWorkspacesMembershipscopestring 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. Expand AllOneOfobjecterrorCodestring A machine-readable code identifying the type of error. Pattern^[a-zA-Z0-9.]$ messagestring A human-readable description of the error intended for debugging purposes only. The exact content of this message is not stable. retryableboolean Whether the request can be automatically retried by the client. objecterrorCodestring A machine-readable code identifying the type of error. Pattern^[a-zA-Z0-9.]$ messagestring A human-readable description of the error intended for debugging purposes only. The exact content of this message is not stable. retryableboolean Whether the request can be automatically retried by the client. objecterrorCodestring A machine-readable code identifying the type of error. Pattern^[a-zA-Z0-9.]$ messagestring A human-readable description of the error intended for debugging purposes only. The exact content of this message is not stable. retryableboolean Whether the request can be automatically retried by the client. objecterrorCodestring A machine-readable code identifying the type of error. Pattern^[a-zA-Z0-9.]$ messagestring A human-readable description of the error intended for debugging purposes only. The exact content of this message is not stable. retryableboolean Whether the request can be automatically retried by the client. objecterrorCodestring A machine-readable code identifying the type of error. Pattern^[a-zA-Z0-9.]$ messagestring A human-readable description of the error intended for debugging purposes only. The exact content of this message is not stable. retryableboolean Whether the request can be automatically retried by the client. objecterrorCodestring A machine-readable code identifying the type of error. Pattern^[a-zA-Z0-9.]$ messagestring A human-readable description of the error intended for debugging purposes only. The exact content of this message is not stable. retryableboolean Whether the request can be automatically retried by the client. detailsobject headerNamestring The name of the given HTTP header which had multiple values. 401 The request was missing required authentication information. This error is not automatically retryable. object errorCodestring A machine-readable code identifying the type of error. Pattern^[a-zA-Z0-9.]$ messagestring A human-readable description of the error intended for debugging purposes only. The exact content of this message is not stable. retryableboolean Whether the request can be automatically retried by the client. 404 The requested resource was not found. This error is not automatically retryable. object errorCodestring A machine-readable code identifying the type of error. Pattern^[a-zA-Z0-9.]$ messagestring A human-readable description of the error intended for debugging purposes only. The exact content of this message is not stable. retryableboolean Whether the request can be automatically retried by the client. 422 This operation is not permitted on the requested resource because it is archived. This error is not automatically retryable. object errorCodestring A machine-readable code identifying the type of error. Pattern^[a-zA-Z0-9.]$ messagestring A human-readable description of the error intended for debugging purposes only. The exact content of this message is not stable. retryableboolean Whether the request can be automatically retried by the client. 429 Too many requests have been made to this endpoint in a short time period. This error is not automatically retryable. Expand Allobject errorCodestring A machine-readable code identifying the type of error. Pattern^[a-zA-Z0-9.]$ messagestring A human-readable description of the error intended for debugging purposes only. The exact content of this message is not stable. retryableboolean Whether the request can be automatically retried by the client. detailsobject detailsstring Additional details about this endpoint's rate limits. 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. Expand AllOneOfobjecterrorCodestring A machine-readable code identifying the type of error. Pattern^[a-zA-Z0-9.]$ messagestring A human-readable description of the error intended for debugging purposes only. The exact content of this message is not stable. retryableboolean Whether the request can be automatically retried by the client. objecterrorCodestring A machine-readable code identifying the type of error. Pattern^[a-zA-Z0-9.]$ messagestring A human-readable description of the error intended for debugging purposes only. The exact content of this message is not stable. retryableboolean Whether the request can be automatically retried by the client. detailsobject resourceNamestring The name of the resource that failed validation. resourceIdstring The id of the resource that failed validation.