Jump to

• Request
• Response
• Examples

View Keyword Redirect Group.

get

/gsadmin/v1/{appName}/redirects/{redirectGroup}

Returns the configuration of the specified keyword redirect group. Returns metadata about the keyword redirect group(e.g. who created it and when) along with the redirect entries inside it. If zip extension is specified (add ".zip" at the end of the path), the keyword redirect group 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".
• redirectGroup: string
  Specifies the redirect group name, for example, Default.

Security

• basicAuth: basic
  Type: basic

  Description: Basic username/password authentication.

Back to Top

Response

Supported Media Types

• application/json
• application/zip

200 Response

Keyword Redirect Group Configuration.

Body ()

Root Schema : RedirectGroup

Type: object

Represents a Redirect Group configuration. Child Nodes represent Redirect Entry configuration confirming to RedirectEntry JSON schema

Show Source

• ecr:createDate(optional): string
• ecr:lastModified(optional): string
• ecr:lastModifiedBy(optional): string
• ecr:type(optional): string
  Default Value: redirect-group

{
    "type":"object",
    "properties":{
        "ecr:type":{
            "type":"string",
            "default":"redirect-group"
        },
        "ecr:createDate":{
            "type":"string"
        },
        "ecr:lastModified":{
            "type":"string"
        },
        "ecr:lastModifiedBy":{
            "type":"string"
        }
    },
    "description":"Represents a Redirect Group configuration. Child Nodes represent Redirect Entry configuration confirming to RedirectEntry JSON schema"
}

Back to Top

Examples

The following example shows how to export the configuration of the default redirect-group:

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

Back to Top