Jump to

• Request
• Response
• Examples

View Keyword Redirects

get

/gsadmin/v1/{appName}/redirects

Returns the keyword redirects configuration for the specified application. Returns metadata about the keyword redirects (e.g. who created it and when) along with the list of redirect groups. If zip extension is specified (add ".zip" at the end of the path), the keyword redirects configuration is exported as a zip file.

Request

Supported Media Types

• application/json

Path Parameters

• appName: string
  Specifies the name of your application. For example, "cloud".

Security

• basicAuth: basic
  Type: basic

  Description: Basic username/password authentication.

Back to Top

Response

Supported Media Types

• application/json
• application/zip

200 Response

Keyword Redirects Configuration.

Body ()

Root Schema : Redirects

Type: object

Represents an application's Keyword Redirects configuration. Child Nodes represent Redirect Group configuration confirming to RedirectGroup JSON schema

Show Source

• ecr:createDate(optional): string
• ecr:lastModified(optional): string
• ecr:lastModifiedBy(optional): string
• ecr:type(optional): string
  Default Value: redirects

{
    "type":"object",
    "properties":{
        "ecr:type":{
            "type":"string",
            "default":"redirects"
        },
        "ecr:createDate":{
            "type":"string"
        },
        "ecr:lastModified":{
            "type":"string"
        },
        "ecr:lastModifiedBy":{
            "type":"string"
        }
    },
    "description":"Represents an application's Keyword Redirects configuration. Child Nodes represent Redirect Group configuration confirming to RedirectGroup JSON schema"
}

Back to Top

Examples

The following examples show how to export the entire keyword redirect configuration for the cloud application:

curl -H "Authorization:Bearer token" -X GET http://host:port/gsadmin/v1/cloud/redirects > /pathname/filename.txt (JSON format)

curl -H "Authorization:Bearer token" -X GET http://host:port/gsadmin/v1/cloud/redirects.zip -o /pathname/filename.zip (ZIP format)

Back to Top