Test Source IP

Test Source Ip

client.Settings.Session.TestSourceIP(ctx, body) (*AllowedboolCheckedIPstringDetailsSettingSessionTestSourceIPResponseDetailsSettingSessionTestSourceIPResponse, error)

post/api/v1/settings/session/test-source-ip

Invokes the c1.api.settings.v1.SessionSettingsService.TestSourceIP method.

Parameters

bodyAllowCidrfieldSourceIPfieldSettingSessionTestSourceIPParams

Hide ParametersShow Parameters

AllowCidrfield

optional

param.Field[[]string]

The allowCidr field.

SourceIPfield

optional

param.Field[string]

if unset, uses the source IP of the request

Returns

SettingSessionTestSourceIPResponsestruct

The TestSourceIPResponse message.

Hide ParametersShow Parameters

Allowedbool

optional

The allowed field.

CheckedIPstring

optional

The checkedIp field.

DetailsCodeint64DetailsarrayMessagestringSettingSessionTestSourceIPResponseDetails

optional

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.

You can find out more about this error model and how to work with it in the API Design Guide.

Hide ParametersShow Parameters

Codeint64

optional

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

formatint32

Detailsarray

optional

[]SettingSessionTestSourceIPResponseDetailsDetail

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Hide ParametersShow Parameters

Typestring

optional

The type of the serialized message.

Messagestring

optional

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

Request example Go

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := conductoronesdk.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.Settings.Session.TestSourceIP(context.TODO(), conductoronesdk.SettingSessionTestSourceIPParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Allowed)
}

200 Example

{
  "allowed": true,
  "checkedIp": "checkedIp",
  "details": {
    "code": 0,
    "details": [
      {
        "@type": "@type"
      }
    ],
    "message": "message"
  }
}