Redirect

List every short URL of the tenant.

get

/api/{tenantId}/redirect

Unpaged and in no guaranteed order. Short URLs past their expiration date are included.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Responses

200

The tenant's short URLs.

A short URL of the tenant and the page it redirects to.

idstringRequired

Case-sensitive alphanumeric code generated on create. It is the last segment of Neo.Web.Redirect.Controllers.WebRedirectEntity.Uri and the key of every other short URL endpoint.

layoutstringRequired

Page of the tenant's web app the visitor lands on: the short URL redirects to {publicUrl}/{tenantId}/{layout}.

creationDateone ofOptional

When the short URL was created, in UTC. Kept unchanged by an update. Accepts ISO 8601 date-time string or Unix epoch seconds in request inputs. Responses are serialized as ISO 8601 date-time strings.

string · date-timeOptional

or

integer · int64Optional

uristringRequired

The short URL to share: the platform's redirect domain followed by Neo.Web.Redirect.Controllers.WebRedirectEntity.Id. A visit redirects (302) to the layout and emits a redirected event; an unknown id answers 404.

401

The caller is not authenticated.

application/problem+json

403

The caller lacks the tenant.redirect:read scope, or the endpoint is not enabled for the tenant.

application/problem+json

429

Over 1200 requests per minute to this endpoint for the tenant (default limit); retry after Retry-After.

application/problem+json

get/api/{tenantId}/redirect

GET /api/{tenantId}/redirect HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "text",
    "layout": "text",
    "creationDate": "2026-01-01T00:00:00.000Z",
    "parameters": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "options": {
      "expirationDate": null,
      "label": null,
      "length": 1
    },
    "uri": "text"
  }
]

Create a short URL.

post

/api/{tenantId}/redirect

The id is generated by the server; its length comes from options.length.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Body

Short URL to create, or the full replacement of an existing one.

layoutstring · min: 1Required

Page of the tenant's web app the short URL redirects to, as a path below {publicUrl}/{tenantId}/.

Responses

201

The created short URL.

A short URL of the tenant and the page it redirects to.

idstringRequired

Case-sensitive alphanumeric code generated on create. It is the last segment of Neo.Web.Redirect.Controllers.WebRedirectEntity.Uri and the key of every other short URL endpoint.

layoutstringRequired

Page of the tenant's web app the visitor lands on: the short URL redirects to {publicUrl}/{tenantId}/{layout}.

creationDateone ofOptional

When the short URL was created, in UTC. Kept unchanged by an update. Accepts ISO 8601 date-time string or Unix epoch seconds in request inputs. Responses are serialized as ISO 8601 date-time strings.

string · date-timeOptional

or

integer · int64Optional

uristringRequired

The short URL to share: the platform's redirect domain followed by Neo.Web.Redirect.Controllers.WebRedirectEntity.Id. A visit redirects (302) to the layout and emits a redirected event; an unknown id answers 404.

400

layout is missing.

401

The caller is not authenticated.

application/problem+json

403

The caller lacks the tenant.redirect:write scope, or the endpoint is not enabled for the tenant.

application/problem+json

429

Over 1200 requests per minute to this endpoint for the tenant (default limit); retry after Retry-After.

application/problem+json

post/api/{tenantId}/redirect

POST /api/{tenantId}/redirect HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 123

{
  "layout": "text",
  "parameters": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "options": {
    "expirationDate": null,
    "label": null,
    "length": 1
  }
}

{
  "id": "text",
  "layout": "text",
  "creationDate": "2026-01-01T00:00:00.000Z",
  "parameters": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "options": {
    "expirationDate": null,
    "label": null,
    "length": 1
  },
  "uri": "text"
}

Get one short URL.

get

/api/{tenantId}/redirect/{id}

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2implicitRequired

Authorization URL:

Path parameters

idstring · min: 3Required

Short URL id (case-sensitive, at least 3 characters).

tenantIdstringRequired

Responses

200

The short URL.

A short URL of the tenant and the page it redirects to.

idstringRequired

Case-sensitive alphanumeric code generated on create. It is the last segment of Neo.Web.Redirect.Controllers.WebRedirectEntity.Uri and the key of every other short URL endpoint.

layoutstringRequired

Page of the tenant's web app the visitor lands on: the short URL redirects to {publicUrl}/{tenantId}/{layout}.

creationDateone ofOptional

When the short URL was created, in UTC. Kept unchanged by an update. Accepts ISO 8601 date-time string or Unix epoch seconds in request inputs. Responses are serialized as ISO 8601 date-time strings.

string · date-timeOptional

or

integer · int64Optional

uristringRequired

The short URL to share: the platform's redirect domain followed by Neo.Web.Redirect.Controllers.WebRedirectEntity.Id. A visit redirects (302) to the layout and emits a redirected event; an unknown id answers 404.

401

The caller is not authenticated.

application/problem+json

403

The caller lacks the tenant.redirect:read scope, or the endpoint is not enabled for the tenant.

application/problem+json

404

No short URL with this id in the tenant.

429

Over 1200 requests per minute to this endpoint for the tenant (default limit); retry after Retry-After.

application/problem+json

get/api/{tenantId}/redirect/{id}

GET /api/{tenantId}/redirect/{id} HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "text",
  "layout": "text",
  "creationDate": "2026-01-01T00:00:00.000Z",
  "parameters": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "options": {
    "expirationDate": null,
    "label": null,
    "length": 1
  },
  "uri": "text"
}

Replace the target of a short URL.

put

/api/{tenantId}/redirect/{id}

The id, the shared URL and the creation date are kept; layout, parameters, label and expiration date are replaced by the body, so an omitted one is cleared. options.length applies on create only.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2implicitRequired

Authorization URL:

Path parameters

idstring · min: 3Required

Short URL id (case-sensitive, at least 3 characters).

tenantIdstringRequired

Body

Short URL to create, or the full replacement of an existing one.

layoutstring · min: 1Required

Page of the tenant's web app the short URL redirects to, as a path below {publicUrl}/{tenantId}/.

Responses

200

The updated short URL.

A short URL of the tenant and the page it redirects to.

idstringRequired

Case-sensitive alphanumeric code generated on create. It is the last segment of Neo.Web.Redirect.Controllers.WebRedirectEntity.Uri and the key of every other short URL endpoint.

layoutstringRequired

Page of the tenant's web app the visitor lands on: the short URL redirects to {publicUrl}/{tenantId}/{layout}.

creationDateone ofOptional

When the short URL was created, in UTC. Kept unchanged by an update. Accepts ISO 8601 date-time string or Unix epoch seconds in request inputs. Responses are serialized as ISO 8601 date-time strings.

string · date-timeOptional

or

integer · int64Optional

uristringRequired

The short URL to share: the platform's redirect domain followed by Neo.Web.Redirect.Controllers.WebRedirectEntity.Id. A visit redirects (302) to the layout and emits a redirected event; an unknown id answers 404.

400

layout is missing.

401

The caller is not authenticated.

application/problem+json

403

The caller lacks the tenant.redirect:write scope, or the endpoint is not enabled for the tenant.

application/problem+json

404

No short URL with this id in the tenant; nothing was changed.

429

Over 1200 requests per minute to this endpoint for the tenant (default limit); retry after Retry-After.

application/problem+json

put/api/{tenantId}/redirect/{id}

PUT /api/{tenantId}/redirect/{id} HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 123

{
  "layout": "text",
  "parameters": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "options": {
    "expirationDate": null,
    "label": null,
    "length": 1
  }
}

{
  "id": "text",
  "layout": "text",
  "creationDate": "2026-01-01T00:00:00.000Z",
  "parameters": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "options": {
    "expirationDate": null,
    "label": null,
    "length": 1
  },
  "uri": "text"
}

Delete a short URL.

delete

/api/{tenantId}/redirect/{id}

From then on the shared URL answers 404.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2implicitRequired

Authorization URL:

Path parameters

idstring · min: 3Required

Short URL id (case-sensitive, at least 3 characters).

tenantIdstringRequired

Responses

200

Deleted, with the short URL as it was.

A short URL of the tenant and the page it redirects to.

idstringRequired

Case-sensitive alphanumeric code generated on create. It is the last segment of Neo.Web.Redirect.Controllers.WebRedirectEntity.Uri and the key of every other short URL endpoint.

layoutstringRequired

Page of the tenant's web app the visitor lands on: the short URL redirects to {publicUrl}/{tenantId}/{layout}.

creationDateone ofOptional

When the short URL was created, in UTC. Kept unchanged by an update. Accepts ISO 8601 date-time string or Unix epoch seconds in request inputs. Responses are serialized as ISO 8601 date-time strings.

string · date-timeOptional

or

integer · int64Optional

uristringRequired

The short URL to share: the platform's redirect domain followed by Neo.Web.Redirect.Controllers.WebRedirectEntity.Id. A visit redirects (302) to the layout and emits a redirected event; an unknown id answers 404.

401

The caller is not authenticated.

application/problem+json

403

The caller lacks the tenant.redirect:write scope, or the endpoint is not enabled for the tenant.

application/problem+json

404

No short URL with this id in the tenant.

429

Over 1200 requests per minute to this endpoint for the tenant (default limit); retry after Retry-After.

application/problem+json

delete/api/{tenantId}/redirect/{id}

DELETE /api/{tenantId}/redirect/{id} HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "text",
  "layout": "text",
  "creationDate": "2026-01-01T00:00:00.000Z",
  "parameters": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "options": {
    "expirationDate": null,
    "label": null,
    "length": 1
  },
  "uri": "text"
}