Partial update Keyword Redirects Configuration

patch

/gsadmin/v1/{appName}/redirects

Partial updates redirects configuration of the specified application.

• Request
• Response
• Examples

Request

Supported Media Types

• application/json

Path Parameters

appName

Type: string

Required: true

Specifies the name of your application, for example, Discover.

Body Parameter

The request body represents the partially updated redirects configuration.

Root Schema : Redirects

Type: object

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

Properties

ecr:createDate

Type: string

ecr:lastModified

Type: string

ecr:lastModifiedBy

Type: string

ecr:type

Type: string

Default Value: redirects

Security

basicAuth

Type: basic

Description: Basic username/password authentication.

Response

Supported Media Types

• application/json

202 Response

Keyword Redirects successfully updated.

Body

Root Schema : Response

Type: object

Properties

message

Type: string

status

Type: integer (int32)

Examples

A PATCH endpoint cannot access an object through its parent object. Thus, you cannot use this endpoint to modify the redirect-entry objects or redirect-group objects contained in the redirects object. The following request generates an error:

PATCH /gsadmin/v1/cloud/redirects

Request Body

{
  "ecr:type": "redirects",
  "Default": {
    "ecr:type": "redirect-group",
    "id1": {
      "ecr:type": "redirect-entry",
      "url": "/browse/kodak/_/N-1z141wh"
     }
  },
}