Redirect

List all the redirection associated to this tenant

get

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/redirect

Returns all configured redirects for the tenant (both active and expired) as an async enumerable stream.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Responses

200

List of all redirection

text/plainapplication/jsontext/json

idstring · nullableRequired

Identifier of the redirect

layoutstring · nullableRequired

Layout associated to this redirect

creationDatestring · date-timeOptional

Creation date of this redirect

parametersobject · nullableOptional

Optional parameters to add to the layout url

uristring · nullableRequired

Short uri of the redirection uri

401

Not authorized

text/plainapplication/jsontext/json

500

Internal server error while listing redirects

get

/api/{tenantId}/redirect

HTTPcURLJavaScriptPython

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

[
  {
    "id": null,
    "layout": null,
    "creationDate": "2026-03-05T00:38:17.593Z",
    "parameters": null,
    "options": {
      "expirationDate": null,
      "label": null,
      "length": 1
    },
    "uri": null
  }
]

Create a new redirect

post

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/redirect

Creates a new redirect with the specified layout, parameters, and optional configuration (expiration date, label, URL length).

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Body

application/jsontext/jsonapplication/*+json

layoutstring · min: 1Required

Name of the layout to create a redirection for

parametersobject · nullableOptional

List of parameters that should be included in the uri

Responses

201

Returns the newly created item

text/plainapplication/jsontext/json

401

Not authorized

text/plainapplication/jsontext/json

500

Internal server error while creating redirect

post

/api/{tenantId}/redirect

HTTPcURLJavaScriptPython

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

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

application/jsontext/jsonapplication/*+json

{
  "id": null,
  "layout": null,
  "creationDate": "2026-03-05T00:38:17.593Z",
  "parameters": null,
  "options": {
    "expirationDate": null,
    "label": null,
    "length": 1
  },
  "uri": null
}

Get detail of a specific redirection

get

https://app.neostore.cloudhttps://app-qa.neostore.cloud

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

Retrieves full details of a redirect including its layout, parameters, and configuration options.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

idstring · min: 3Required

id of the redirection

tenantIdstringRequired

Responses

200

return the specified item

text/plainapplication/jsontext/json

idstring · nullableRequired

Identifier of the redirect

layoutstring · nullableRequired

Layout associated to this redirect

creationDatestring · date-timeOptional

Creation date of this redirect

parametersobject · nullableOptional

Optional parameters to add to the layout url

uristring · nullableRequired

Short uri of the redirection uri

401

Not authorized

text/plainapplication/jsontext/json

404

If the item does not exists

text/plainapplication/jsontext/json

500

Internal server error while retrieving redirect

get

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

HTTPcURLJavaScriptPython

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

{
  "id": null,
  "layout": null,
  "creationDate": "2026-03-05T00:38:17.593Z",
  "parameters": null,
  "options": {
    "expirationDate": null,
    "label": null,
    "length": 1
  },
  "uri": null
}

Update a specific redirection. All properties will be overwritten by the new entity.

put

https://app.neostore.cloudhttps://app-qa.neostore.cloud

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

Replaces the entire redirect configuration (PUT operation). All properties must be provided.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

idstring · min: 3Required

Identifier of the redirection to update.

tenantIdstringRequired

Body

application/jsontext/jsonapplication/*+json

layoutstring · min: 1Required

Name of the layout to create a redirection for

parametersobject · nullableOptional

List of parameters that should be included in the uri

Responses

201

Returns the updated item

text/plainapplication/jsontext/json

204

if the item to update has not been found

401

Not authorized

text/plainapplication/jsontext/json

500

Internal server error while updating redirect

put

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

HTTPcURLJavaScriptPython

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

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

application/jsontext/jsonapplication/*+json

{
  "id": null,
  "layout": null,
  "creationDate": "2026-03-05T00:38:17.593Z",
  "parameters": null,
  "options": {
    "expirationDate": null,
    "label": null,
    "length": 1
  },
  "uri": null
}

Delete the requested redirection

delete

https://app.neostore.cloudhttps://app-qa.neostore.cloud

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

Removes the redirect from the system and returns the deleted entity for confirmation.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

idstring · min: 3Required

Identifier of the redirection to delete

tenantIdstringRequired

Responses

200

When the object has been successfully deleted

text/plainapplication/jsontext/json

idstring · nullableRequired

Identifier of the redirect

layoutstring · nullableRequired

Layout associated to this redirect

creationDatestring · date-timeOptional

Creation date of this redirect

parametersobject · nullableOptional

Optional parameters to add to the layout url

uristring · nullableRequired

Short uri of the redirection uri

204

if the item to delete has not been found

401

Not authorized

text/plainapplication/jsontext/json

500

Internal server error while deleting redirect

delete

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

HTTPcURLJavaScriptPython

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

{
  "id": null,
  "layout": null,
  "creationDate": "2026-03-05T00:38:17.593Z",
  "parameters": null,
  "options": {
    "expirationDate": null,
    "label": null,
    "length": 1
  },
  "uri": null
}