Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All

    Update Core File Information for an End Customer

    When operating Junos Space Service Now in Partner Proxy mode, use this API to update the FTP or SFTP server configuration for uploading core files for an end customer.

    URI

    /api/juniper/servicenow/organization-management/organization/{id}/ updateCoreFileConfigurationForEC (HTTP method = PUT)

    URI Parameters

    Parameter

    Type

    Required

    Description

    id

    String

    Yes

    ID of the end customer organization for which FTP or SFTP server configuration must be updated

    Consumes

    • application/vnd.juniper.servicenow.organization-management.organization. uploadCoreFileConfigurationForEC+xml;version=1;charset=UTF-8
    • application/vnd.juniper.servicenow.organization-management.organization. uploadCoreFileConfigurationForEC+json;version=1;charset=UTF-8

    Request Elements

    Element

    Type

    Description

    coreFileUploadType

    String

    Type of upload

    Possible values—DISABLED, FTP, SFTP, and BOTH

    ftpServer

    String

    IP address in the IPv4 or IPv6 format or hostname of the FTP server

    ftpUsername

    String

    Username of the FTP server

    ftpPassword

    String

    Password of the FTP server

    ftpPath

    String

    Path on the FTP server to upload core files

    sftpServer

    String

    IP address in the IPv4 or IPv6 format or hostname of the SFTP server

    sftpUsername

    String

    Username of the SFTP server

    sftpPassword

    String

    Password of the SFTP server

    sftpPath

    String

    Path on the SFTP server to upload core files

    Produces

    • application/vnd.juniper.servicenow.organization-management.organization. uploadCoreFileConfigurationForEC+xml;version=1
    • application/vnd.juniper.servicenow.organization-management.organization. uploadCoreFileConfigurationForEC+json;version=1

    Response Elements

    Element

    Type

    Description

    coreFileUploadType

    String

    Type of upload

    Possible values—DISABLED, FTP, SFTP, and BOTH

    ftpServer

    String

    IP address in the IPv4 or IPv6 format or hostname of the FTP server

    ftpUsername

    String

    Username of the FTP server

    ftpPassword

    String

    Password of the FTP server

    ftpPath

    String

    Path on the FTP server to upload core files

    sftpServer

    String

    IP address in the IPv4 or IPv6 format or hostname of the FTP server

    sftpUsername

    String

    Username of the SFTP server

    sftpPassword

    String

    Password of the SFTP server

    sftpPath

    String

    Path on the SFTP server to upload core files

    Sample Input

    Sample XML Input

    <uploadCoreFileConfigurationForEC>
    <coreFileUploadType>BOTH</coreFileUploadType>
    <ftpServer>ftp.example.com</ftpServer>
    <ftpUsername>user@example.com</ftpUsername>
    <ftpPassword>password</ftpPassword>
    <ftpPath>/pub/incoming/</ftpPath>
    <sftpServer>sftp.example.com</sftpServer>
    <sftpUsername>user@example.com</sftpUsername>
    <sftpPassword>password</sftpPassword>
    <sftpPath>/pub/incoming/</sftpPath>
    </uploadCoreFileConfigurationForEC>
    

    Sample JSON Input

    {
      "uploadCoreFileConfigurationForEC": {
        "coreFileUploadType": "BOTH",
        "ftpServer": "ftp.example.com",
        "ftpUsername": "user@example.com",
        "ftpPassword": "password",
        "ftpPath": "/pub/incoming/",
    "sftpServer": "sftp.example.com",
        "sftpUsername": "user@example.com",
    "sftpPassword": "password",
        "sftpPath": "/pub/incoming/"
      }
    }
    

    Sample Output

    Sample XML Output

    <uploadCoreFileConfigurationForEC>
    <coreFileUploadType>BOTH</coreFileUploadType>
    <ftpServer>ftp.example.com</ftpServer>
    <ftpUsername>user@example.com</ftpUsername>
    <ftpPassword>password</ftpPassword>
    <ftpPath>/pub/incoming/</ftpPath>
    <sftpServer>sftp.example.com</sftpServer>
    <sftpUsername>user@example.com</sftpUsername>
    <sftpPassword>password</sftpPassword>
    <sftpPath>/pub/incoming/</sftpPath>
    </uploadCoreFileConfigurationForEC>
    

    Sample JSON Output

    {
      "uploadCoreFileConfigurationForEC": {
          "coreFileUploadType": "BOTH",
        "ftpServer": "ftp.example.com",
        "ftpUsername": "user@example.com",
        "ftpPassword": "password",
        "ftpPath": "/pub/incoming/",
    "sftpServer": "sftp.example.com",
        "sftpUsername": "user@example.com",
    "sftpPassword": "password",
        "sftpPath": "/pub/incoming/"
      }
    }
    

    Modified: 2016-08-09