Manage API Versions

Manage API Versions
lac42
As your API evolves, you can create API versions. You can add, change, and remove resources yet preserve the existing API under an older version. Your API's clients typically expect a certain set of resources to be available. The API versions are part of the URL of a REST endpoint. To prevent breaking the clients, create an API version.
You can create different namespaces for the resources that you define explicitly in your API using API Creator using the version name unique string value.
For more information about the portion of the URL that reflects the request that you are coding, including the API version, see The API URL.
In this article:
2
Create a Clone of an API Version
  1. With your API open, in the Create section, click
    Versions
    .
    A list of API versions display in the list.
  2. Click the version that you want to clone from the list, and then click
    Clone <version name>
    .
A clone of the API is created.
Switch Between API Versions
  1. With your API open, in the Create section, click 
    Resources
    .
    The Resource tab displays by default.
  2. Select the version to which you want to switch from the
    API Version
    drop-down.
Filter by API Version
You can filter by version name in the REST Lab.
For more information about how to filter by version name, see Test your API Using the REST Lab.
The apiversion Endpoint
The
apiversion
 endpoint includes the following attributes:
Attribute Name
Type
Description
ident
integer
The unique identifier for this object.
Required:
Yes
ts
timestamp
The date and time when this object was created or last modified.
Required:
Yes
name
string(50)
The name for this API version. This must be a short name, valid in a URL. Use only letters, numbers, dash, period, and underscore.
Required:
Yes
comments
string(1000)
The description for this API version.
Example:
Version 1 of my API.
Required:
No
project_ident
integer
The
ident
of the API that contains this API version.
Required:
Yes