GetServerByIp

Retrieve the FactoryTalk Historian server (Data Archive) that is connected to the API server by its IP address.

Input Parameter

Item
Description
Request
GET
URL Parameter
ip
: String (required). The IP address of the FactoryTalk Historian server.
Request Header
Authentication
: String (required). Bearer Token string returned from the Login action.
Request Body
None
Status Code
  • 200
    : The request succeeded.
  • 400
    : Bad request. For example, the URL parameter is not provided.
  • 401
    : Unauthorized.
  • 403
    : Forbidden.
  • 404
    : Resource not found.
  • 500
    : Internal server error.

Sample

Request Header
"Authorization": "eyJhbGciOiJIUzI1N…"
Request URL Parameter
ip=xxx.xxx.xxx.xxx
TIP:
Historian WebAPI does not support IPv6.
Response Body
{
	"Result": {
		"ServerName": "HisSrvName",
		"ServerHost": "HisSrvHost"
	},
	"Success": true,
	"ErrorMessage": ""
}
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal